const (
// DefaultBaseURI is the default URI used for the service Apimanagement
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
APIClient is the apiManagement Client
type APIClient struct {
BaseClient
}
func NewAPIClient(subscriptionID string) APIClient
NewAPIClient creates an instance of the APIClient client.
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 (client APIClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, parameters APICreateOrUpdateParameter, ifMatch string) (result APIContract, err error)
CreateOrUpdate creates new or updates existing specified API of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. parameters - create or update parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (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 (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 (client APIClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (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 (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 (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 (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 (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 (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 (client APIClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
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 (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 (client APIClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (client APIClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32, expandAPIVersionSet *bool) (result APICollectionPage, err error)
ListByService lists all APIs of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top - number of records to return. skip - number of records to skip. expandAPIVersionSet - include full ApiVersionSet resource in response
func (client APIClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32, expandAPIVersionSet *bool) (result APICollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client APIClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32, expandAPIVersionSet *bool) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (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 (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 (client APIClient) ListByTags(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result TagResourceCollectionPage, err error)
ListByTags lists a collection of apis associated with tags. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | aid | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | isCurrent | eq | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client APIClient) ListByTagsComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result TagResourceCollectionIterator, err error)
ListByTagsComplete enumerates all values, automatically crossing page boundaries as required.
func (client APIClient) ListByTagsPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByTagsPreparer prepares the ListByTags request.
func (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 (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 (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 (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 (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 (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.
APICollection paged Api list representation.
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"`
}
func (ac APICollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (ac APICollection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APICollection.
APICollectionIterator provides access to a complete listing of APIContract values.
type APICollectionIterator struct {
// contains filtered or unexported fields
}
func NewAPICollectionIterator(page APICollectionPage) APICollectionIterator
Creates a new instance of the APICollectionIterator type.
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 (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 (iter APICollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter APICollectionIterator) Response() APICollection
Response returns the raw server response from the last page request.
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.
APICollectionPage contains a page of APIContract values.
type APICollectionPage struct {
// contains filtered or unexported fields
}
func NewAPICollectionPage(cur APICollection, getNextPage func(context.Context, APICollection) (APICollection, error)) APICollectionPage
Creates a new instance of the APICollectionPage type.
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 (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 (page APICollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page APICollectionPage) Response() APICollection
Response returns the raw server response from the last page request.
func (page APICollectionPage) Values() []APIContract
Values returns the slice of values for the current page or nil if there are no values.
APIContract API details.
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"`
}
func (ac APIContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APIContract.
func (ac *APIContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for APIContract struct.
APIContractProperties api Entity Properties
type APIContractProperties struct {
// DisplayName - API name.
DisplayName *string `json:"displayName,omitempty"`
// ServiceURL - Absolute URL of the backend service implementing this API.
ServiceURL *string `json:"serviceUrl,omitempty"`
// Path - Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
Path *string `json:"path,omitempty"`
// Protocols - Describes on which protocols the operations in this API can be invoked.
Protocols *[]Protocol `json:"protocols,omitempty"`
APIVersionSet *APIVersionSetContractDetails `json:"apiVersionSet,omitempty"`
// Description - Description of the API. May include HTML formatting tags.
Description *string `json:"description,omitempty"`
// AuthenticationSettings - Collection of authentication settings included into this API.
AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`
// SubscriptionKeyParameterNames - Protocols over which API is made available.
SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
// APIType - Type of API. Possible values include: 'HTTP', 'Soap'
APIType APIType `json:"type,omitempty"`
// APIRevision - Describes the Revision of the Api. If no value is provided, default revision 1 is created
APIRevision *string `json:"apiRevision,omitempty"`
// APIVersion - Indicates the Version identifier of the API if the API is versioned
APIVersion *string `json:"apiVersion,omitempty"`
// IsCurrent - READ-ONLY; 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"`
}
func (acp APIContractProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APIContractProperties.
APIContractUpdateProperties API update contract properties.
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 - READ-ONLY; 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"`
}
func (acup APIContractUpdateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APIContractUpdateProperties.
APICreateOrUpdateParameter API Create or Update Parameters.
type APICreateOrUpdateParameter struct {
// APICreateOrUpdateProperties - Api entity create of update properties.
*APICreateOrUpdateProperties `json:"properties,omitempty"`
}
func (acoup APICreateOrUpdateParameter) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APICreateOrUpdateParameter.
func (acoup *APICreateOrUpdateParameter) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for APICreateOrUpdateParameter struct.
APICreateOrUpdateProperties api Create or Update Properties.
type APICreateOrUpdateProperties struct {
// ContentValue - Content value when Importing an API.
ContentValue *string `json:"contentValue,omitempty"`
// ContentFormat - Format of the Content in which the API is getting imported. Possible values include: 'WadlXML', 'WadlLinkJSON', 'SwaggerJSON', 'SwaggerLinkJSON', 'Wsdl', 'WsdlLink'
ContentFormat ContentFormat `json:"contentFormat,omitempty"`
// WsdlSelector - Criteria to limit import of WSDL to a subset of the document.
WsdlSelector *APICreateOrUpdatePropertiesWsdlSelector `json:"wsdlSelector,omitempty"`
// SoapAPIType - Type of Api to create.
// * `http` creates a SOAP to REST API
// * `soap` creates a SOAP pass-through API. Possible values include: 'SoapToRest', 'SoapPassThrough'
SoapAPIType SoapAPIType `json:"apiType,omitempty"`
// DisplayName - API name.
DisplayName *string `json:"displayName,omitempty"`
// ServiceURL - Absolute URL of the backend service implementing this API.
ServiceURL *string `json:"serviceUrl,omitempty"`
// Path - Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
Path *string `json:"path,omitempty"`
// Protocols - Describes on which protocols the operations in this API can be invoked.
Protocols *[]Protocol `json:"protocols,omitempty"`
APIVersionSet *APIVersionSetContractDetails `json:"apiVersionSet,omitempty"`
// Description - Description of the API. May include HTML formatting tags.
Description *string `json:"description,omitempty"`
// AuthenticationSettings - Collection of authentication settings included into this API.
AuthenticationSettings *AuthenticationSettingsContract `json:"authenticationSettings,omitempty"`
// SubscriptionKeyParameterNames - Protocols over which API is made available.
SubscriptionKeyParameterNames *SubscriptionKeyParameterNamesContract `json:"subscriptionKeyParameterNames,omitempty"`
// APIType - Type of API. Possible values include: 'HTTP', 'Soap'
APIType APIType `json:"type,omitempty"`
// APIRevision - Describes the Revision of the Api. If no value is provided, default revision 1 is created
APIRevision *string `json:"apiRevision,omitempty"`
// APIVersion - Indicates the Version identifier of the API if the API is versioned
APIVersion *string `json:"apiVersion,omitempty"`
// IsCurrent - READ-ONLY; 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"`
}
func (acoup APICreateOrUpdateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APICreateOrUpdateProperties.
APICreateOrUpdatePropertiesWsdlSelector criteria to limit import of WSDL to a subset of the document.
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"`
}
APIDiagnosticClient is the apiManagement Client
type APIDiagnosticClient struct {
BaseClient
}
func NewAPIDiagnosticClient(subscriptionID string) APIDiagnosticClient
NewAPIDiagnosticClient creates an instance of the APIDiagnosticClient client.
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (client APIDiagnosticClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
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 (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 (client APIDiagnosticClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (client APIDiagnosticClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result DiagnosticCollectionPage, err error)
ListByService lists all diagnostics of an API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (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 (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 (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 (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 (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 (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 (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 (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.
APIDiagnosticLoggerClient is the apiManagement Client
type APIDiagnosticLoggerClient struct {
BaseClient
}
func NewAPIDiagnosticLoggerClient(subscriptionID string) APIDiagnosticLoggerClient
NewAPIDiagnosticLoggerClient creates an instance of the APIDiagnosticLoggerClient client.
func NewAPIDiagnosticLoggerClientWithBaseURI(baseURI string, subscriptionID string) APIDiagnosticLoggerClient
NewAPIDiagnosticLoggerClientWithBaseURI creates an instance of the APIDiagnosticLoggerClient 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 (client APIDiagnosticLoggerClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, loggerid string) (result autorest.Response, err error)
CheckEntityExists checks that logger entity specified by identifier is associated with the diagnostics entity. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. loggerid - logger identifier. Must be unique in the API Management service instance.
func (client APIDiagnosticLoggerClient) CheckEntityExistsPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, loggerid string) (*http.Request, error)
CheckEntityExistsPreparer prepares the CheckEntityExists request.
func (client APIDiagnosticLoggerClient) CheckEntityExistsResponder(resp *http.Response) (result autorest.Response, err error)
CheckEntityExistsResponder handles the response to the CheckEntityExists request. The method always closes the http.Response Body.
func (client APIDiagnosticLoggerClient) CheckEntityExistsSender(req *http.Request) (*http.Response, error)
CheckEntityExistsSender sends the CheckEntityExists request. The method will close the http.Response Body if it receives an error.
func (client APIDiagnosticLoggerClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, loggerid string) (result LoggerContract, err error)
CreateOrUpdate attaches a logger to a diagnostic for an API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. loggerid - logger identifier. Must be unique in the API Management service instance.
func (client APIDiagnosticLoggerClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, loggerid string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client APIDiagnosticLoggerClient) CreateOrUpdateResponder(resp *http.Response) (result LoggerContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client APIDiagnosticLoggerClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client APIDiagnosticLoggerClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, loggerid string) (result autorest.Response, err error)
Delete deletes the specified Logger from Diagnostic for an API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. loggerid - logger identifier. Must be unique in the API Management service instance.
func (client APIDiagnosticLoggerClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, loggerid string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client APIDiagnosticLoggerClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client APIDiagnosticLoggerClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client APIDiagnosticLoggerClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, filter string, top *int32, skip *int32) (result LoggerCollectionPage, err error)
ListByService lists all loggers associated with the specified Diagnostic of an API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | type | eq | | top - number of records to return. skip - number of records to skip.
func (client APIDiagnosticLoggerClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, filter string, top *int32, skip *int32) (result LoggerCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client APIDiagnosticLoggerClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, diagnosticID string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client APIDiagnosticLoggerClient) ListByServiceResponder(resp *http.Response) (result LoggerCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client APIDiagnosticLoggerClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
APIEntityBaseContract API base contract details.
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 - READ-ONLY; 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"`
}
func (aebc APIEntityBaseContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APIEntityBaseContract.
APIExportClient is the apiManagement Client
type APIExportClient struct {
BaseClient
}
func NewAPIExportClient(subscriptionID string) APIExportClient
NewAPIExportClient creates an instance of the APIExportClient client.
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 (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 (client APIExportClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, formatParameter ExportFormat) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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.
APIExportResult API Export result Blob Uri.
type APIExportResult struct {
autorest.Response `json:"-"`
// Link - Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes.
Link *string `json:"link,omitempty"`
}
APIIssueAttachmentClient is the apiManagement Client
type APIIssueAttachmentClient struct {
BaseClient
}
func NewAPIIssueAttachmentClient(subscriptionID string) APIIssueAttachmentClient
NewAPIIssueAttachmentClient creates an instance of the APIIssueAttachmentClient client.
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 (client APIIssueAttachmentClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, attachmentID string, parameters IssueAttachmentContract, ifMatch string) (result IssueAttachmentContract, err error)
CreateOrUpdate creates a new Attachment for the Issue in an API or updates an existing one. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. attachmentID - attachment identifier within an Issue. Must be unique in the current Issue. parameters - create parameters. ifMatch - eTag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (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 (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 (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 (client APIIssueAttachmentClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, attachmentID string, ifMatch string) (result autorest.Response, err error)
Delete deletes the specified comment from an Issue. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. attachmentID - attachment identifier within an Issue. Must be unique in the current Issue. ifMatch - eTag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (client APIIssueAttachmentClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, filter string, top *int32, skip *int32) (result IssueAttachmentCollectionPage, err error)
ListByService lists all comments for the Issue 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 | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (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 (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 (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 (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.
APIIssueClient is the apiManagement Client
type APIIssueClient struct {
BaseClient
}
func NewAPIIssueClient(subscriptionID string) APIIssueClient
NewAPIIssueClient creates an instance of the APIIssueClient client.
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 (client APIIssueClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, parameters IssueContract, ifMatch string) (result IssueContract, err error)
CreateOrUpdate creates a new Issue for an API or updates an existing one. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. parameters - create parameters. ifMatch - eTag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (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 (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 (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 (client APIIssueClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, ifMatch string) (result autorest.Response, err error)
Delete deletes the specified Issue from an API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (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 (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 (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 (client APIIssueClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string) (result IssueContract, err error)
Get gets the details of the Issue for an API specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance.
func (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 (client APIIssueClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
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 (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 (client APIIssueClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (client APIIssueClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result IssueCollectionPage, err error)
ListByService lists all issues 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 | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | state | eq | | | userId | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client APIIssueClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result IssueCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client APIIssueClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (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 (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 (client APIIssueClient) Update(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, parameters IssueUpdateContract, ifMatch string) (result autorest.Response, err error)
Update updates an existing issue for an API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (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 (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 (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.
APIIssueCommentClient is the apiManagement Client
type APIIssueCommentClient struct {
BaseClient
}
func NewAPIIssueCommentClient(subscriptionID string) APIIssueCommentClient
NewAPIIssueCommentClient creates an instance of the APIIssueCommentClient client.
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 (client APIIssueCommentClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, commentID string, parameters IssueCommentContract, ifMatch string) (result IssueCommentContract, err error)
CreateOrUpdate creates a new Comment for the Issue in an API or updates an existing one. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. commentID - comment identifier within an Issue. Must be unique in the current Issue. parameters - create parameters. ifMatch - eTag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (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 (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 (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 (client APIIssueCommentClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, issueID string, commentID string, ifMatch string) (result autorest.Response, err error)
Delete deletes the specified comment from an Issue. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. issueID - issue identifier. Must be unique in the current API Management service instance. commentID - comment identifier within an Issue. Must be unique in the current Issue. ifMatch - eTag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (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 (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 (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 (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.
APIOperationClient is the apiManagement Client
type APIOperationClient struct {
BaseClient
}
func NewAPIOperationClient(subscriptionID string) APIOperationClient
NewAPIOperationClient creates an instance of the APIOperationClient client.
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (client APIOperationClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
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 (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 (client APIOperationClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (client APIOperationClient) ListByAPI(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result OperationCollectionPage, err error)
ListByAPI lists a collection of the operations for the specified API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | method | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | urlTemplate | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client APIOperationClient) ListByAPIComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result OperationCollectionIterator, err error)
ListByAPIComplete enumerates all values, automatically crossing page boundaries as required.
func (client APIOperationClient) ListByAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByAPIPreparer prepares the ListByAPI request.
func (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 (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 (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 (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 (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 (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.
APIOperationPolicyClient is the apiManagement Client
type APIOperationPolicyClient struct {
BaseClient
}
func NewAPIOperationPolicyClient(subscriptionID string) APIOperationPolicyClient
NewAPIOperationPolicyClient creates an instance of the APIOperationPolicyClient client.
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 (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 (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 (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 (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 (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 (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 (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 (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 (client APIOperationPolicyClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string) (result PolicyContract, err error)
Get get the policy configuration at the API Operation level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance.
func (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 (client APIOperationPolicyClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
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 (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 (client APIOperationPolicyClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (client APIOperationPolicyClient) ListByOperationPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string) (*http.Request, error)
ListByOperationPreparer prepares the ListByOperation request.
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 (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.
APIPolicyClient is the apiManagement Client
type APIPolicyClient struct {
BaseClient
}
func NewAPIPolicyClient(subscriptionID string) APIPolicyClient
NewAPIPolicyClient creates an instance of the APIPolicyClient client.
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 (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 (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 (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 (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 (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 (client APIPolicyClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (client APIPolicyClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiid string) (result PolicyContract, err error)
Get get the policy configuration at the API level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
func (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 (client APIPolicyClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
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 (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 (client APIPolicyClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (client APIPolicyClient) ListByAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string) (*http.Request, error)
ListByAPIPreparer prepares the ListByAPI request.
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 (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.
APIProductClient is the apiManagement Client
type APIProductClient struct {
BaseClient
}
func NewAPIProductClient(subscriptionID string) APIProductClient
NewAPIProductClient creates an instance of the APIProductClient client.
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 (client APIProductClient) ListByApis(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result ProductCollectionPage, err error)
ListByApis lists all Products, which the API is part of. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (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 (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 (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 (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.
APIReleaseClient is the apiManagement Client
type APIReleaseClient struct {
BaseClient
}
func NewAPIReleaseClient(subscriptionID string) APIReleaseClient
NewAPIReleaseClient creates an instance of the APIReleaseClient client.
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 (client APIReleaseClient) Create(ctx context.Context, resourceGroupName string, serviceName string, apiid string, releaseID string, parameters APIReleaseContract) (result APIReleaseContract, err error)
Create creates a new Release for the API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. releaseID - release identifier within an API. Must be unique in the current API Management service instance. parameters - create parameters.
func (client APIReleaseClient) CreatePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, releaseID string, parameters APIReleaseContract) (*http.Request, error)
CreatePreparer prepares the Create request.
func (client APIReleaseClient) CreateResponder(resp *http.Response) (result APIReleaseContract, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (client APIReleaseClient) CreateSender(req *http.Request) (*http.Response, error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (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 (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 (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 (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 (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 (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 (client APIReleaseClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, releaseID string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
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 (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 (client APIReleaseClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, releaseID string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (client APIReleaseClient) List(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result APIReleaseCollectionPage, err error)
List lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | |notes|ge le eq ne gt lt|substringof contains startswith endswith| top - number of records to return. skip - number of records to skip.
func (client APIReleaseClient) ListComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result APIReleaseCollectionIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client APIReleaseClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (*http.Request, error)
ListPreparer prepares the List request.
func (client APIReleaseClient) ListResponder(resp *http.Response) (result APIReleaseCollection, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client APIReleaseClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (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 (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 (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 (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.
APIReleaseCollection paged Api Revision list representation.
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"`
}
func (arc APIReleaseCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (arc APIReleaseCollection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APIReleaseCollection.
APIReleaseCollectionIterator provides access to a complete listing of APIReleaseContract values.
type APIReleaseCollectionIterator struct {
// contains filtered or unexported fields
}
func NewAPIReleaseCollectionIterator(page APIReleaseCollectionPage) APIReleaseCollectionIterator
Creates a new instance of the APIReleaseCollectionIterator type.
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 (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 (iter APIReleaseCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter APIReleaseCollectionIterator) Response() APIReleaseCollection
Response returns the raw server response from the last page request.
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.
APIReleaseCollectionPage contains a page of APIReleaseContract values.
type APIReleaseCollectionPage struct {
// contains filtered or unexported fields
}
func NewAPIReleaseCollectionPage(cur APIReleaseCollection, getNextPage func(context.Context, APIReleaseCollection) (APIReleaseCollection, error)) APIReleaseCollectionPage
Creates a new instance of the APIReleaseCollectionPage type.
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 (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 (page APIReleaseCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page APIReleaseCollectionPage) Response() APIReleaseCollection
Response returns the raw server response from the last page request.
func (page APIReleaseCollectionPage) Values() []APIReleaseContract
Values returns the slice of values for the current page or nil if there are no values.
APIReleaseContract api Release details.
type APIReleaseContract struct {
autorest.Response `json:"-"`
// APIReleaseContractProperties - Properties of the Api Release Contract.
*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"`
}
func (arc APIReleaseContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APIReleaseContract.
func (arc *APIReleaseContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for APIReleaseContract struct.
APIReleaseContractProperties API Release details
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"`
}
func (arcp APIReleaseContractProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APIReleaseContractProperties.
APIRevisionCollection paged Api Revision list representation.
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"`
}
func (arc APIRevisionCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (arc APIRevisionCollection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APIRevisionCollection.
APIRevisionCollectionIterator provides access to a complete listing of APIRevisionContract values.
type APIRevisionCollectionIterator struct {
// contains filtered or unexported fields
}
func NewAPIRevisionCollectionIterator(page APIRevisionCollectionPage) APIRevisionCollectionIterator
Creates a new instance of the APIRevisionCollectionIterator type.
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 (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 (iter APIRevisionCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter APIRevisionCollectionIterator) Response() APIRevisionCollection
Response returns the raw server response from the last page request.
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.
APIRevisionCollectionPage contains a page of APIRevisionContract values.
type APIRevisionCollectionPage struct {
// contains filtered or unexported fields
}
func NewAPIRevisionCollectionPage(cur APIRevisionCollection, getNextPage func(context.Context, APIRevisionCollection) (APIRevisionCollection, error)) APIRevisionCollectionPage
Creates a new instance of the APIRevisionCollectionPage type.
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 (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 (page APIRevisionCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page APIRevisionCollectionPage) Response() APIRevisionCollection
Response returns the raw server response from the last page request.
func (page APIRevisionCollectionPage) Values() []APIRevisionContract
Values returns the slice of values for the current page or nil if there are no values.
APIRevisionContract summary of revision metadata.
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"`
}
func (arc APIRevisionContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APIRevisionContract.
APIRevisionInfoContract object used to create an API Revision or Version based on an existing API Revision
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"`
}
APIRevisionsClient is the apiManagement Client
type APIRevisionsClient struct {
BaseClient
}
func NewAPIRevisionsClient(subscriptionID string) APIRevisionsClient
NewAPIRevisionsClient creates an instance of the APIRevisionsClient client.
func NewAPIRevisionsClientWithBaseURI(baseURI string, subscriptionID string) APIRevisionsClient
NewAPIRevisionsClientWithBaseURI creates an instance of the APIRevisionsClient 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 (client APIRevisionsClient) List(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result APIRevisionCollectionPage, err error)
List lists all revisions of an API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------|
|apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| top - number of records to return. skip - number of records to skip.
func (client APIRevisionsClient) ListComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result APIRevisionCollectionIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client APIRevisionsClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (*http.Request, error)
ListPreparer prepares the List request.
func (client APIRevisionsClient) ListResponder(resp *http.Response) (result APIRevisionCollection, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client APIRevisionsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
APISchemaClient is the apiManagement Client
type APISchemaClient struct {
BaseClient
}
func NewAPISchemaClient(subscriptionID string) APISchemaClient
NewAPISchemaClient creates an instance of the APISchemaClient client.
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 (client APISchemaClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, schemaID string, parameters SchemaContract, ifMatch string) (result SchemaContract, err error)
CreateOrUpdate creates or updates schema configuration for the API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. schemaID - schema identifier within an API. Must be unique in the current API Management service instance. parameters - the schema contents to apply. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (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 (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 (client APISchemaClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client APISchemaClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, schemaID string, ifMatch string) (result autorest.Response, err error)
Delete deletes the schema configuration at the Api. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. schemaID - schema identifier within an API. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client APISchemaClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, schemaID string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (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 (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 (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 (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 (client APISchemaClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, schemaID string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
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 (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 (client APISchemaClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, schemaID string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (client APISchemaClient) ListByAPI(ctx context.Context, resourceGroupName string, serviceName string, apiid string) (result SchemaCollectionPage, err error)
ListByAPI get the schema configuration at the API level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
func (client APISchemaClient) ListByAPIComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string) (result SchemaCollectionIterator, err error)
ListByAPIComplete enumerates all values, automatically crossing page boundaries as required.
func (client APISchemaClient) ListByAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string) (*http.Request, error)
ListByAPIPreparer prepares the ListByAPI request.
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 (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.
APITagResourceContractProperties API contract properties for the Tag Resources.
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 - READ-ONLY; 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"`
}
func (atrcp APITagResourceContractProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APITagResourceContractProperties.
APIType enumerates the values for api type.
type APIType string
const (
// HTTP ...
HTTP APIType = "http"
// Soap ...
Soap APIType = "soap"
)
func PossibleAPITypeValues() []APIType
PossibleAPITypeValues returns an array of possible values for the APIType const type.
APIUpdateContract API update contract details.
type APIUpdateContract struct {
// APIContractUpdateProperties - Properties of the API entity that can be updated.
*APIContractUpdateProperties `json:"properties,omitempty"`
}
func (auc APIUpdateContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APIUpdateContract.
func (auc *APIUpdateContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for APIUpdateContract struct.
APIVersionSetClient is the apiManagement Client
type APIVersionSetClient struct {
BaseClient
}
func NewAPIVersionSetClient(subscriptionID string) APIVersionSetClient
NewAPIVersionSetClient creates an instance of the APIVersionSetClient client.
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 (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 (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 (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 (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 (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 (client APIVersionSetClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client APIVersionSetClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the Api Version Set specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. versionSetID - api Version Set identifier. Must be unique in the current API Management service instance.
func (client APIVersionSetClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client APIVersionSetClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client APIVersionSetClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client APIVersionSetClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client APIVersionSetClient) GetResponder(resp *http.Response) (result APIVersionSetContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client APIVersionSetClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client APIVersionSetClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result APIVersionSetCollectionPage, err error)
ListByService lists a collection of API Version Sets in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |------------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | N/A | | registrationDate | ge, le, eq, ne, gt, lt | N/A | | note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client APIVersionSetClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result APIVersionSetCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client APIVersionSetClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client APIVersionSetClient) ListByServiceResponder(resp *http.Response) (result APIVersionSetCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client APIVersionSetClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
func (client APIVersionSetClient) Update(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string, parameters APIVersionSetUpdateParameters, ifMatch string) (result autorest.Response, err error)
Update updates the details of the Api VersionSet specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. versionSetID - api Version Set identifier. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client APIVersionSetClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, versionSetID string, parameters APIVersionSetUpdateParameters, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client APIVersionSetClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client APIVersionSetClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
APIVersionSetCollection paged Api Version Set list representation.
type APIVersionSetCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]APIVersionSetContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (avsc APIVersionSetCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
APIVersionSetCollectionIterator provides access to a complete listing of APIVersionSetContract values.
type APIVersionSetCollectionIterator struct {
// contains filtered or unexported fields
}
func NewAPIVersionSetCollectionIterator(page APIVersionSetCollectionPage) APIVersionSetCollectionIterator
Creates a new instance of the APIVersionSetCollectionIterator type.
func (iter *APIVersionSetCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *APIVersionSetCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter APIVersionSetCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter APIVersionSetCollectionIterator) Response() APIVersionSetCollection
Response returns the raw server response from the last page request.
func (iter APIVersionSetCollectionIterator) Value() APIVersionSetContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
APIVersionSetCollectionPage contains a page of APIVersionSetContract values.
type APIVersionSetCollectionPage struct {
// contains filtered or unexported fields
}
func NewAPIVersionSetCollectionPage(cur APIVersionSetCollection, getNextPage func(context.Context, APIVersionSetCollection) (APIVersionSetCollection, error)) APIVersionSetCollectionPage
Creates a new instance of the APIVersionSetCollectionPage type.
func (page *APIVersionSetCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *APIVersionSetCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page APIVersionSetCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page APIVersionSetCollectionPage) Response() APIVersionSetCollection
Response returns the raw server response from the last page request.
func (page APIVersionSetCollectionPage) Values() []APIVersionSetContract
Values returns the slice of values for the current page or nil if there are no values.
APIVersionSetContract api Version Set Contract details.
type APIVersionSetContract struct {
autorest.Response `json:"-"`
// APIVersionSetContractProperties - Api VersionSet contract properties.
*APIVersionSetContractProperties `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"`
}
func (avsc APIVersionSetContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APIVersionSetContract.
func (avsc *APIVersionSetContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for APIVersionSetContract struct.
APIVersionSetContractDetails an API Version Set contains the common configuration for a set of API Versions relating
type APIVersionSetContractDetails struct {
// ID - Identifier for existing API Version Set. Omit this value to create a new Version Set.
ID *string `json:"id,omitempty"`
// Description - Description of API Version Set.
Description *string `json:"description,omitempty"`
// VersioningScheme - An value that determines where the API Version identifer will be located in a HTTP request. Possible values include: 'VersioningScheme1Segment', 'VersioningScheme1Query', 'VersioningScheme1Header'
VersioningScheme VersioningScheme1 `json:"versioningScheme,omitempty"`
// VersionQueryName - Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
VersionQueryName *string `json:"versionQueryName,omitempty"`
// VersionHeaderName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
VersionHeaderName *string `json:"versionHeaderName,omitempty"`
}
APIVersionSetContractProperties properties of an API Version Set.
type APIVersionSetContractProperties struct {
// DisplayName - Name of API Version Set
DisplayName *string `json:"displayName,omitempty"`
// VersioningScheme - An value that determines where the API Version identifer will be located in a HTTP request. Possible values include: 'VersioningSchemeSegment', 'VersioningSchemeQuery', 'VersioningSchemeHeader'
VersioningScheme VersioningScheme `json:"versioningScheme,omitempty"`
// Description - Description of API Version Set.
Description *string `json:"description,omitempty"`
// VersionQueryName - Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
VersionQueryName *string `json:"versionQueryName,omitempty"`
// VersionHeaderName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
VersionHeaderName *string `json:"versionHeaderName,omitempty"`
}
APIVersionSetEntityBase api Version set base parameters
type APIVersionSetEntityBase struct {
// Description - Description of API Version Set.
Description *string `json:"description,omitempty"`
// VersionQueryName - Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
VersionQueryName *string `json:"versionQueryName,omitempty"`
// VersionHeaderName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
VersionHeaderName *string `json:"versionHeaderName,omitempty"`
}
APIVersionSetUpdateParameters parameters to update or create an Api Version Set Contract.
type APIVersionSetUpdateParameters struct {
// APIVersionSetUpdateParametersProperties - Parameters to update or create an Api Version Set Contract.
*APIVersionSetUpdateParametersProperties `json:"properties,omitempty"`
}
func (avsup APIVersionSetUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for APIVersionSetUpdateParameters.
func (avsup *APIVersionSetUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for APIVersionSetUpdateParameters struct.
APIVersionSetUpdateParametersProperties properties used to create or update an API Version Set.
type APIVersionSetUpdateParametersProperties struct {
// DisplayName - Name of API Version Set
DisplayName *string `json:"displayName,omitempty"`
// VersioningScheme - An value that determines where the API Version identifer will be located in a HTTP request. Possible values include: 'VersioningSchemeSegment', 'VersioningSchemeQuery', 'VersioningSchemeHeader'
VersioningScheme VersioningScheme `json:"versioningScheme,omitempty"`
// Description - Description of API Version Set.
Description *string `json:"description,omitempty"`
// VersionQueryName - Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
VersionQueryName *string `json:"versionQueryName,omitempty"`
// VersionHeaderName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
VersionHeaderName *string `json:"versionHeaderName,omitempty"`
}
AccessInformationContract tenant access information contract of the API Management service.
type AccessInformationContract struct {
autorest.Response `json:"-"`
// ID - Identifier.
ID *string `json:"id,omitempty"`
// PrimaryKey - Primary access key.
PrimaryKey *string `json:"primaryKey,omitempty"`
// SecondaryKey - Secondary access key.
SecondaryKey *string `json:"secondaryKey,omitempty"`
// Enabled - Tenant access information of the API Management service.
Enabled *bool `json:"enabled,omitempty"`
}
AccessInformationUpdateParameters tenant access information update parameters of the API Management service.
type AccessInformationUpdateParameters struct {
// Enabled - Tenant access information of the API Management service.
Enabled *bool `json:"enabled,omitempty"`
}
AdditionalLocation description of an additional API Management resource location.
type AdditionalLocation struct {
// Location - The location name of the additional region among Azure Data center regions.
Location *string `json:"location,omitempty"`
// Sku - SKU properties of the API Management service.
Sku *ServiceSkuProperties `json:"sku,omitempty"`
// PublicIPAddresses - READ-ONLY; Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.
PublicIPAddresses *[]string `json:"publicIPAddresses,omitempty"`
// PrivateIPAddresses - READ-ONLY; Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard and Premium SKU.
PrivateIPAddresses *[]string `json:"privateIPAddresses,omitempty"`
// VirtualNetworkConfiguration - Virtual network configuration for the location.
VirtualNetworkConfiguration *VirtualNetworkConfiguration `json:"virtualNetworkConfiguration,omitempty"`
// GatewayRegionalURL - READ-ONLY; Gateway URL of the API Management service in the Region.
GatewayRegionalURL *string `json:"gatewayRegionalUrl,omitempty"`
}
func (al AdditionalLocation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AdditionalLocation.
ApimResource the Resource definition.
type ApimResource struct {
// 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 is set to Microsoft.ApiManagement.
Type *string `json:"type,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}
func (ar ApimResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ApimResource.
AsyncOperationStatus enumerates the values for async operation status.
type AsyncOperationStatus string
const (
// Failed ...
Failed AsyncOperationStatus = "Failed"
// InProgress ...
InProgress AsyncOperationStatus = "InProgress"
// Started ...
Started AsyncOperationStatus = "Started"
// Succeeded ...
Succeeded AsyncOperationStatus = "Succeeded"
)
func PossibleAsyncOperationStatusValues() []AsyncOperationStatus
PossibleAsyncOperationStatusValues returns an array of possible values for the AsyncOperationStatus const type.
AuthenticationSettingsContract API Authentication Settings.
type AuthenticationSettingsContract struct {
// OAuth2 - OAuth2 Authentication settings
OAuth2 *OAuth2AuthenticationSettingsContract `json:"oAuth2,omitempty"`
// Openid - OpenID Connect Authentication Settings
Openid *OpenIDAuthenticationSettingsContract `json:"openid,omitempty"`
// SubscriptionKeyRequired - Specifies whether subscription key is required during call to this API, true - API is included into closed products only, false - API is included into open products alone, null - there is a mix of products.
SubscriptionKeyRequired *bool `json:"subscriptionKeyRequired,omitempty"`
}
AuthorizationMethod enumerates the values for authorization method.
type AuthorizationMethod string
const (
// DELETE ...
DELETE AuthorizationMethod = "DELETE"
// GET ...
GET AuthorizationMethod = "GET"
// HEAD ...
HEAD AuthorizationMethod = "HEAD"
// OPTIONS ...
OPTIONS AuthorizationMethod = "OPTIONS"
// PATCH ...
PATCH AuthorizationMethod = "PATCH"
// POST ...
POST AuthorizationMethod = "POST"
// PUT ...
PUT AuthorizationMethod = "PUT"
// TRACE ...
TRACE AuthorizationMethod = "TRACE"
)
func PossibleAuthorizationMethodValues() []AuthorizationMethod
PossibleAuthorizationMethodValues returns an array of possible values for the AuthorizationMethod const type.
AuthorizationServerClient is the apiManagement Client
type AuthorizationServerClient struct {
BaseClient
}
func NewAuthorizationServerClient(subscriptionID string) AuthorizationServerClient
NewAuthorizationServerClient creates an instance of the AuthorizationServerClient client.
func NewAuthorizationServerClientWithBaseURI(baseURI string, subscriptionID string) AuthorizationServerClient
NewAuthorizationServerClientWithBaseURI creates an instance of the AuthorizationServerClient 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 (client AuthorizationServerClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, authsid string, parameters AuthorizationServerContract, ifMatch string) (result AuthorizationServerContract, err error)
CreateOrUpdate creates new authorization server or updates an existing authorization server. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. authsid - identifier of the authorization server. parameters - create or update parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client AuthorizationServerClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, authsid string, parameters AuthorizationServerContract, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client AuthorizationServerClient) CreateOrUpdateResponder(resp *http.Response) (result AuthorizationServerContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client AuthorizationServerClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client AuthorizationServerClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, authsid string, ifMatch string) (result autorest.Response, err error)
Delete deletes specific authorization server instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. authsid - identifier of the authorization server. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client AuthorizationServerClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, authsid string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client AuthorizationServerClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client AuthorizationServerClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client AuthorizationServerClient) Get(ctx context.Context, resourceGroupName string, serviceName string, authsid string) (result AuthorizationServerContract, err error)
Get gets the details of the authorization server specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. authsid - identifier of the authorization server.
func (client AuthorizationServerClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, authsid string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the authorizationServer specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. authsid - identifier of the authorization server.
func (client AuthorizationServerClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, authsid string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client AuthorizationServerClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client AuthorizationServerClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client AuthorizationServerClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, authsid string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client AuthorizationServerClient) GetResponder(resp *http.Response) (result AuthorizationServerContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client AuthorizationServerClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client AuthorizationServerClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result AuthorizationServerCollectionPage, err error)
ListByService lists a collection of authorization servers defined within a service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client AuthorizationServerClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result AuthorizationServerCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client AuthorizationServerClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client AuthorizationServerClient) ListByServiceResponder(resp *http.Response) (result AuthorizationServerCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client AuthorizationServerClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
func (client AuthorizationServerClient) Update(ctx context.Context, resourceGroupName string, serviceName string, authsid string, parameters AuthorizationServerUpdateContract, ifMatch string) (result autorest.Response, err error)
Update updates the details of the authorization server specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. authsid - identifier of the authorization server. parameters - oAuth2 Server settings Update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client AuthorizationServerClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, authsid string, parameters AuthorizationServerUpdateContract, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client AuthorizationServerClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client AuthorizationServerClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
AuthorizationServerCollection paged OAuth2 Authorization Servers list representation.
type AuthorizationServerCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]AuthorizationServerContract `json:"value,omitempty"`
// Count - Total record count number across all pages.
Count *int64 `json:"count,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (asc AuthorizationServerCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
AuthorizationServerCollectionIterator provides access to a complete listing of AuthorizationServerContract values.
type AuthorizationServerCollectionIterator struct {
// contains filtered or unexported fields
}
func NewAuthorizationServerCollectionIterator(page AuthorizationServerCollectionPage) AuthorizationServerCollectionIterator
Creates a new instance of the AuthorizationServerCollectionIterator type.
func (iter *AuthorizationServerCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *AuthorizationServerCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter AuthorizationServerCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter AuthorizationServerCollectionIterator) Response() AuthorizationServerCollection
Response returns the raw server response from the last page request.
func (iter AuthorizationServerCollectionIterator) Value() AuthorizationServerContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
AuthorizationServerCollectionPage contains a page of AuthorizationServerContract values.
type AuthorizationServerCollectionPage struct {
// contains filtered or unexported fields
}
func NewAuthorizationServerCollectionPage(cur AuthorizationServerCollection, getNextPage func(context.Context, AuthorizationServerCollection) (AuthorizationServerCollection, error)) AuthorizationServerCollectionPage
Creates a new instance of the AuthorizationServerCollectionPage type.
func (page *AuthorizationServerCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *AuthorizationServerCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page AuthorizationServerCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AuthorizationServerCollectionPage) Response() AuthorizationServerCollection
Response returns the raw server response from the last page request.
func (page AuthorizationServerCollectionPage) Values() []AuthorizationServerContract
Values returns the slice of values for the current page or nil if there are no values.
AuthorizationServerContract external OAuth authorization server settings.
type AuthorizationServerContract struct {
autorest.Response `json:"-"`
// AuthorizationServerContractProperties - Properties of the External OAuth authorization server Contract.
*AuthorizationServerContractProperties `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"`
}
func (asc AuthorizationServerContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AuthorizationServerContract.
func (asc *AuthorizationServerContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AuthorizationServerContract struct.
AuthorizationServerContractBaseProperties external OAuth authorization server Update settings contract.
type AuthorizationServerContractBaseProperties struct {
// Description - Description of the authorization server. Can contain HTML formatting tags.
Description *string `json:"description,omitempty"`
// AuthorizationMethods - HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
AuthorizationMethods *[]AuthorizationMethod `json:"authorizationMethods,omitempty"`
// ClientAuthenticationMethod - Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
ClientAuthenticationMethod *[]ClientAuthenticationMethod `json:"clientAuthenticationMethod,omitempty"`
// TokenBodyParameters - Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.
TokenBodyParameters *[]TokenBodyParameterContract `json:"tokenBodyParameters,omitempty"`
// TokenEndpoint - OAuth token endpoint. Contains absolute URI to entity being referenced.
TokenEndpoint *string `json:"tokenEndpoint,omitempty"`
// SupportState - If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
SupportState *bool `json:"supportState,omitempty"`
// DefaultScope - Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
DefaultScope *string `json:"defaultScope,omitempty"`
// BearerTokenSendingMethods - Specifies the mechanism by which access token is passed to the API.
BearerTokenSendingMethods *[]BearerTokenSendingMethod `json:"bearerTokenSendingMethods,omitempty"`
// ClientSecret - Client or app secret registered with this authorization server.
ClientSecret *string `json:"clientSecret,omitempty"`
// ResourceOwnerUsername - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
ResourceOwnerUsername *string `json:"resourceOwnerUsername,omitempty"`
// ResourceOwnerPassword - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
ResourceOwnerPassword *string `json:"resourceOwnerPassword,omitempty"`
}
AuthorizationServerContractProperties external OAuth authorization server settings Properties.
type AuthorizationServerContractProperties struct {
// DisplayName - User-friendly authorization server name.
DisplayName *string `json:"displayName,omitempty"`
// ClientRegistrationEndpoint - Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
ClientRegistrationEndpoint *string `json:"clientRegistrationEndpoint,omitempty"`
// AuthorizationEndpoint - OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
AuthorizationEndpoint *string `json:"authorizationEndpoint,omitempty"`
// GrantTypes - Form of an authorization grant, which the client uses to request the access token.
GrantTypes *[]GrantType `json:"grantTypes,omitempty"`
// ClientID - Client or app id registered with this authorization server.
ClientID *string `json:"clientId,omitempty"`
// Description - Description of the authorization server. Can contain HTML formatting tags.
Description *string `json:"description,omitempty"`
// AuthorizationMethods - HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
AuthorizationMethods *[]AuthorizationMethod `json:"authorizationMethods,omitempty"`
// ClientAuthenticationMethod - Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
ClientAuthenticationMethod *[]ClientAuthenticationMethod `json:"clientAuthenticationMethod,omitempty"`
// TokenBodyParameters - Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.
TokenBodyParameters *[]TokenBodyParameterContract `json:"tokenBodyParameters,omitempty"`
// TokenEndpoint - OAuth token endpoint. Contains absolute URI to entity being referenced.
TokenEndpoint *string `json:"tokenEndpoint,omitempty"`
// SupportState - If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
SupportState *bool `json:"supportState,omitempty"`
// DefaultScope - Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
DefaultScope *string `json:"defaultScope,omitempty"`
// BearerTokenSendingMethods - Specifies the mechanism by which access token is passed to the API.
BearerTokenSendingMethods *[]BearerTokenSendingMethod `json:"bearerTokenSendingMethods,omitempty"`
// ClientSecret - Client or app secret registered with this authorization server.
ClientSecret *string `json:"clientSecret,omitempty"`
// ResourceOwnerUsername - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
ResourceOwnerUsername *string `json:"resourceOwnerUsername,omitempty"`
// ResourceOwnerPassword - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
ResourceOwnerPassword *string `json:"resourceOwnerPassword,omitempty"`
}
AuthorizationServerUpdateContract external OAuth authorization server settings.
type AuthorizationServerUpdateContract struct {
// AuthorizationServerUpdateContractProperties - Properties of the External OAuth authorization server update Contract.
*AuthorizationServerUpdateContractProperties `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"`
}
func (asuc AuthorizationServerUpdateContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AuthorizationServerUpdateContract.
func (asuc *AuthorizationServerUpdateContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AuthorizationServerUpdateContract struct.
AuthorizationServerUpdateContractProperties external OAuth authorization server Update settings contract.
type AuthorizationServerUpdateContractProperties struct {
// DisplayName - User-friendly authorization server name.
DisplayName *string `json:"displayName,omitempty"`
// ClientRegistrationEndpoint - Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
ClientRegistrationEndpoint *string `json:"clientRegistrationEndpoint,omitempty"`
// AuthorizationEndpoint - OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
AuthorizationEndpoint *string `json:"authorizationEndpoint,omitempty"`
// GrantTypes - Form of an authorization grant, which the client uses to request the access token.
GrantTypes *[]GrantType `json:"grantTypes,omitempty"`
// ClientID - Client or app id registered with this authorization server.
ClientID *string `json:"clientId,omitempty"`
// Description - Description of the authorization server. Can contain HTML formatting tags.
Description *string `json:"description,omitempty"`
// AuthorizationMethods - HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
AuthorizationMethods *[]AuthorizationMethod `json:"authorizationMethods,omitempty"`
// ClientAuthenticationMethod - Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
ClientAuthenticationMethod *[]ClientAuthenticationMethod `json:"clientAuthenticationMethod,omitempty"`
// TokenBodyParameters - Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.
TokenBodyParameters *[]TokenBodyParameterContract `json:"tokenBodyParameters,omitempty"`
// TokenEndpoint - OAuth token endpoint. Contains absolute URI to entity being referenced.
TokenEndpoint *string `json:"tokenEndpoint,omitempty"`
// SupportState - If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
SupportState *bool `json:"supportState,omitempty"`
// DefaultScope - Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
DefaultScope *string `json:"defaultScope,omitempty"`
// BearerTokenSendingMethods - Specifies the mechanism by which access token is passed to the API.
BearerTokenSendingMethods *[]BearerTokenSendingMethod `json:"bearerTokenSendingMethods,omitempty"`
// ClientSecret - Client or app secret registered with this authorization server.
ClientSecret *string `json:"clientSecret,omitempty"`
// ResourceOwnerUsername - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
ResourceOwnerUsername *string `json:"resourceOwnerUsername,omitempty"`
// ResourceOwnerPassword - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
ResourceOwnerPassword *string `json:"resourceOwnerPassword,omitempty"`
}
BackendAuthorizationHeaderCredentials authorization header information.
type BackendAuthorizationHeaderCredentials struct {
// Scheme - Authentication Scheme name.
Scheme *string `json:"scheme,omitempty"`
// Parameter - Authentication Parameter value.
Parameter *string `json:"parameter,omitempty"`
}
BackendBaseParameters backend entity base Parameter set.
type BackendBaseParameters struct {
// Title - Backend Title.
Title *string `json:"title,omitempty"`
// Description - Backend Description.
Description *string `json:"description,omitempty"`
// ResourceID - Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.
ResourceID *string `json:"resourceId,omitempty"`
// Properties - Backend Properties contract
Properties *BackendProperties `json:"properties,omitempty"`
// Credentials - Backend Credentials Contract Properties
Credentials *BackendCredentialsContract `json:"credentials,omitempty"`
// Proxy - Backend Proxy Contract Properties
Proxy *BackendProxyContract `json:"proxy,omitempty"`
// TLS - Backend TLS Properties
TLS *BackendTLSProperties `json:"tls,omitempty"`
}
BackendClient is the apiManagement Client
type BackendClient struct {
BaseClient
}
func NewBackendClient(subscriptionID string) BackendClient
NewBackendClient creates an instance of the BackendClient client.
func NewBackendClientWithBaseURI(baseURI string, subscriptionID string) BackendClient
NewBackendClientWithBaseURI creates an instance of the BackendClient 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 (client BackendClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, backendid string, parameters BackendContract, ifMatch string) (result BackendContract, err error)
CreateOrUpdate creates or Updates a backend. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. backendid - identifier of the Backend entity. Must be unique in the current API Management service instance. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client BackendClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, backendid string, parameters BackendContract, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client BackendClient) CreateOrUpdateResponder(resp *http.Response) (result BackendContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client BackendClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client BackendClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, backendid string, ifMatch string) (result autorest.Response, err error)
Delete deletes the specified backend. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. backendid - identifier of the Backend entity. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client BackendClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, backendid string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client BackendClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client BackendClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client BackendClient) Get(ctx context.Context, resourceGroupName string, serviceName string, backendid string) (result BackendContract, err error)
Get gets the details of the backend specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. backendid - identifier of the Backend entity. Must be unique in the current API Management service instance.
func (client BackendClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, backendid string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the backend specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. backendid - identifier of the Backend entity. Must be unique in the current API Management service instance.
func (client BackendClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, backendid string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client BackendClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client BackendClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client BackendClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, backendid string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client BackendClient) GetResponder(resp *http.Response) (result BackendContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client BackendClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client BackendClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result BackendCollectionPage, err error)
ListByService lists a collection of backends in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | host | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client BackendClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result BackendCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client BackendClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client BackendClient) ListByServiceResponder(resp *http.Response) (result BackendCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client BackendClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
func (client BackendClient) Reconnect(ctx context.Context, resourceGroupName string, serviceName string, backendid string, parameters *BackendReconnectContract) (result autorest.Response, err error)
Reconnect notifies the APIM proxy to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. backendid - identifier of the Backend entity. Must be unique in the current API Management service instance. parameters - reconnect request parameters.
func (client BackendClient) ReconnectPreparer(ctx context.Context, resourceGroupName string, serviceName string, backendid string, parameters *BackendReconnectContract) (*http.Request, error)
ReconnectPreparer prepares the Reconnect request.
func (client BackendClient) ReconnectResponder(resp *http.Response) (result autorest.Response, err error)
ReconnectResponder handles the response to the Reconnect request. The method always closes the http.Response Body.
func (client BackendClient) ReconnectSender(req *http.Request) (*http.Response, error)
ReconnectSender sends the Reconnect request. The method will close the http.Response Body if it receives an error.
func (client BackendClient) Update(ctx context.Context, resourceGroupName string, serviceName string, backendid string, parameters BackendUpdateParameters, ifMatch string) (result autorest.Response, err error)
Update updates an existing backend. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. backendid - identifier of the Backend entity. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client BackendClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, backendid string, parameters BackendUpdateParameters, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client BackendClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client BackendClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
BackendCollection paged Backend list representation.
type BackendCollection struct {
autorest.Response `json:"-"`
// Value - Backend values.
Value *[]BackendContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (bc BackendCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
BackendCollectionIterator provides access to a complete listing of BackendContract values.
type BackendCollectionIterator struct {
// contains filtered or unexported fields
}
func NewBackendCollectionIterator(page BackendCollectionPage) BackendCollectionIterator
Creates a new instance of the BackendCollectionIterator type.
func (iter *BackendCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *BackendCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter BackendCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter BackendCollectionIterator) Response() BackendCollection
Response returns the raw server response from the last page request.
func (iter BackendCollectionIterator) Value() BackendContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
BackendCollectionPage contains a page of BackendContract values.
type BackendCollectionPage struct {
// contains filtered or unexported fields
}
func NewBackendCollectionPage(cur BackendCollection, getNextPage func(context.Context, BackendCollection) (BackendCollection, error)) BackendCollectionPage
Creates a new instance of the BackendCollectionPage type.
func (page *BackendCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *BackendCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page BackendCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page BackendCollectionPage) Response() BackendCollection
Response returns the raw server response from the last page request.
func (page BackendCollectionPage) Values() []BackendContract
Values returns the slice of values for the current page or nil if there are no values.
BackendContract backend details.
type BackendContract struct {
autorest.Response `json:"-"`
// BackendContractProperties - Backend entity contract properties.
*BackendContractProperties `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"`
}
func (bc BackendContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for BackendContract.
func (bc *BackendContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for BackendContract struct.
BackendContractProperties parameters supplied to the Create Backend operation.
type BackendContractProperties struct {
// URL - Runtime Url of the Backend.
URL *string `json:"url,omitempty"`
// Protocol - Backend communication protocol. Possible values include: 'BackendProtocolHTTP', 'BackendProtocolSoap'
Protocol BackendProtocol `json:"protocol,omitempty"`
// Title - Backend Title.
Title *string `json:"title,omitempty"`
// Description - Backend Description.
Description *string `json:"description,omitempty"`
// ResourceID - Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.
ResourceID *string `json:"resourceId,omitempty"`
// Properties - Backend Properties contract
Properties *BackendProperties `json:"properties,omitempty"`
// Credentials - Backend Credentials Contract Properties
Credentials *BackendCredentialsContract `json:"credentials,omitempty"`
// Proxy - Backend Proxy Contract Properties
Proxy *BackendProxyContract `json:"proxy,omitempty"`
// TLS - Backend TLS Properties
TLS *BackendTLSProperties `json:"tls,omitempty"`
}
BackendCredentialsContract details of the Credentials used to connect to Backend.
type BackendCredentialsContract struct {
// Certificate - List of Client Certificate Thumbprint.
Certificate *[]string `json:"certificate,omitempty"`
// Query - Query Parameter description.
Query map[string][]string `json:"query"`
// Header - Header Parameter description.
Header map[string][]string `json:"header"`
// Authorization - Authorization header authentication
Authorization *BackendAuthorizationHeaderCredentials `json:"authorization,omitempty"`
}
func (bcc BackendCredentialsContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for BackendCredentialsContract.
BackendProperties properties specific to the Backend Type.
type BackendProperties struct {
// ServiceFabricCluster - Backend Service Fabric Cluster Properties
ServiceFabricCluster *BackendServiceFabricClusterProperties `json:"serviceFabricCluster,omitempty"`
}
BackendProtocol enumerates the values for backend protocol.
type BackendProtocol string
const (
// BackendProtocolHTTP The Backend is a RESTful service.
BackendProtocolHTTP BackendProtocol = "http"
// BackendProtocolSoap The Backend is a SOAP service.
BackendProtocolSoap BackendProtocol = "soap"
)
func PossibleBackendProtocolValues() []BackendProtocol
PossibleBackendProtocolValues returns an array of possible values for the BackendProtocol const type.
BackendProxyContract details of the Backend WebProxy Server to use in the Request to Backend.
type BackendProxyContract struct {
// URL - WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings.
URL *string `json:"url,omitempty"`
// Username - Username to connect to the WebProxy server
Username *string `json:"username,omitempty"`
// Password - Password to connect to the WebProxy Server
Password *string `json:"password,omitempty"`
}
BackendReconnectContract reconnect request parameters.
type BackendReconnectContract struct {
// BackendReconnectProperties - Reconnect request properties.
*BackendReconnectProperties `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"`
}
func (brc BackendReconnectContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for BackendReconnectContract.
func (brc *BackendReconnectContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for BackendReconnectContract struct.
BackendReconnectProperties properties to control reconnect requests.
type BackendReconnectProperties struct {
// After - Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconnect is PT2M.
After *string `json:"after,omitempty"`
}
BackendServiceFabricClusterProperties properties of the Service Fabric Type Backend.
type BackendServiceFabricClusterProperties struct {
// ClientCertificatethumbprint - The client certificate thumbprint for the management endpoint.
ClientCertificatethumbprint *string `json:"clientCertificatethumbprint,omitempty"`
// MaxPartitionResolutionRetries - Maximum number of retries while attempting resolve the partition.
MaxPartitionResolutionRetries *int32 `json:"maxPartitionResolutionRetries,omitempty"`
// ManagementEndpoints - The cluster management endpoint.
ManagementEndpoints *[]string `json:"managementEndpoints,omitempty"`
// ServerCertificateThumbprints - Thumbprints of certificates cluster management service uses for tls communication
ServerCertificateThumbprints *[]string `json:"serverCertificateThumbprints,omitempty"`
// ServerX509Names - Server X509 Certificate Names Collection
ServerX509Names *[]X509CertificateName `json:"serverX509Names,omitempty"`
}
BackendTLSProperties properties controlling TLS Certificate Validation.
type BackendTLSProperties struct {
// ValidateCertificateChain - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
ValidateCertificateChain *bool `json:"validateCertificateChain,omitempty"`
// ValidateCertificateName - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
ValidateCertificateName *bool `json:"validateCertificateName,omitempty"`
}
BackendUpdateParameterProperties parameters supplied to the Update Backend operation.
type BackendUpdateParameterProperties struct {
// URL - Runtime Url of the Backend.
URL *string `json:"url,omitempty"`
// Protocol - Backend communication protocol. Possible values include: 'BackendProtocolHTTP', 'BackendProtocolSoap'
Protocol BackendProtocol `json:"protocol,omitempty"`
// Title - Backend Title.
Title *string `json:"title,omitempty"`
// Description - Backend Description.
Description *string `json:"description,omitempty"`
// ResourceID - Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps.
ResourceID *string `json:"resourceId,omitempty"`
// Properties - Backend Properties contract
Properties *BackendProperties `json:"properties,omitempty"`
// Credentials - Backend Credentials Contract Properties
Credentials *BackendCredentialsContract `json:"credentials,omitempty"`
// Proxy - Backend Proxy Contract Properties
Proxy *BackendProxyContract `json:"proxy,omitempty"`
// TLS - Backend TLS Properties
TLS *BackendTLSProperties `json:"tls,omitempty"`
}
BackendUpdateParameters backend update parameters.
type BackendUpdateParameters struct {
// BackendUpdateParameterProperties - Backend entity update contract properties.
*BackendUpdateParameterProperties `json:"properties,omitempty"`
}
func (bup BackendUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for BackendUpdateParameters.
func (bup *BackendUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for BackendUpdateParameters struct.
BaseClient is the base client for Apimanagement.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
BearerTokenSendingMethod enumerates the values for bearer token sending method.
type BearerTokenSendingMethod string
const (
// AuthorizationHeader ...
AuthorizationHeader BearerTokenSendingMethod = "authorizationHeader"
// Query ...
Query BearerTokenSendingMethod = "query"
)
func PossibleBearerTokenSendingMethodValues() []BearerTokenSendingMethod
PossibleBearerTokenSendingMethodValues returns an array of possible values for the BearerTokenSendingMethod const type.
BearerTokenSendingMethods enumerates the values for bearer token sending methods.
type BearerTokenSendingMethods string
const (
// BearerTokenSendingMethodsAuthorizationHeader Access token will be transmitted in the Authorization
// header using Bearer schema
BearerTokenSendingMethodsAuthorizationHeader BearerTokenSendingMethods = "authorizationHeader"
// BearerTokenSendingMethodsQuery Access token will be transmitted as query parameters.
BearerTokenSendingMethodsQuery BearerTokenSendingMethods = "query"
)
func PossibleBearerTokenSendingMethodsValues() []BearerTokenSendingMethods
PossibleBearerTokenSendingMethodsValues returns an array of possible values for the BearerTokenSendingMethods const type.
CertificateClient is the apiManagement Client
type CertificateClient struct {
BaseClient
}
func NewCertificateClient(subscriptionID string) CertificateClient
NewCertificateClient creates an instance of the CertificateClient client.
func NewCertificateClientWithBaseURI(baseURI string, subscriptionID string) CertificateClient
NewCertificateClientWithBaseURI creates an instance of the CertificateClient 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 (client CertificateClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, certificateID string, parameters CertificateCreateOrUpdateParameters, ifMatch string) (result CertificateContract, err error)
CreateOrUpdate creates or updates the certificate being used for authentication with the backend. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. certificateID - identifier of the certificate entity. Must be unique in the current API Management service instance. parameters - create or Update parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client CertificateClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, certificateID string, parameters CertificateCreateOrUpdateParameters, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client CertificateClient) CreateOrUpdateResponder(resp *http.Response) (result CertificateContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client CertificateClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client CertificateClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, certificateID string, ifMatch string) (result autorest.Response, err error)
Delete deletes specific certificate. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. certificateID - identifier of the certificate entity. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client CertificateClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, certificateID string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client CertificateClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client CertificateClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client CertificateClient) Get(ctx context.Context, resourceGroupName string, serviceName string, certificateID string) (result CertificateContract, err error)
Get gets the details of the certificate specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. certificateID - identifier of the certificate entity. Must be unique in the current API Management service instance.
func (client CertificateClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, certificateID string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the certificate specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. certificateID - identifier of the certificate entity. Must be unique in the current API Management service instance.
func (client CertificateClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, certificateID string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client CertificateClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client CertificateClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client CertificateClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, certificateID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client CertificateClient) GetResponder(resp *http.Response) (result CertificateContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client CertificateClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client CertificateClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result CertificateCollectionPage, err error)
ListByService lists a collection of all certificates in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |----------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | subject | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | thumbprint | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | expirationDate | ge, le, eq, ne, gt, lt | N/A | top - number of records to return. skip - number of records to skip.
func (client CertificateClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result CertificateCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client CertificateClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client CertificateClient) ListByServiceResponder(resp *http.Response) (result CertificateCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client CertificateClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
CertificateCollection paged Certificates list representation.
type CertificateCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]CertificateContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (cc CertificateCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
CertificateCollectionIterator provides access to a complete listing of CertificateContract values.
type CertificateCollectionIterator struct {
// contains filtered or unexported fields
}
func NewCertificateCollectionIterator(page CertificateCollectionPage) CertificateCollectionIterator
Creates a new instance of the CertificateCollectionIterator type.
func (iter *CertificateCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *CertificateCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter CertificateCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter CertificateCollectionIterator) Response() CertificateCollection
Response returns the raw server response from the last page request.
func (iter CertificateCollectionIterator) Value() CertificateContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
CertificateCollectionPage contains a page of CertificateContract values.
type CertificateCollectionPage struct {
// contains filtered or unexported fields
}
func NewCertificateCollectionPage(cur CertificateCollection, getNextPage func(context.Context, CertificateCollection) (CertificateCollection, error)) CertificateCollectionPage
Creates a new instance of the CertificateCollectionPage type.
func (page *CertificateCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *CertificateCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page CertificateCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page CertificateCollectionPage) Response() CertificateCollection
Response returns the raw server response from the last page request.
func (page CertificateCollectionPage) Values() []CertificateContract
Values returns the slice of values for the current page or nil if there are no values.
CertificateConfiguration certificate configuration which consist of non-trusted intermediates and root certificates.
type CertificateConfiguration struct {
// EncodedCertificate - Base64 Encoded certificate.
EncodedCertificate *string `json:"encodedCertificate,omitempty"`
// CertificatePassword - Certificate Password.
CertificatePassword *string `json:"certificatePassword,omitempty"`
// StoreName - The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. Possible values include: 'CertificateAuthority', 'Root'
StoreName StoreName `json:"storeName,omitempty"`
// Certificate - Certificate information.
Certificate *CertificateInformation `json:"certificate,omitempty"`
}
CertificateContract certificate details.
type CertificateContract struct {
autorest.Response `json:"-"`
// CertificateContractProperties - Certificate properties details.
*CertificateContractProperties `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"`
}
func (cc CertificateContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CertificateContract.
func (cc *CertificateContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CertificateContract struct.
CertificateContractProperties properties of the Certificate contract.
type CertificateContractProperties struct {
// Subject - Subject attribute of the certificate.
Subject *string `json:"subject,omitempty"`
// Thumbprint - Thumbprint of the certificate.
Thumbprint *string `json:"thumbprint,omitempty"`
// ExpirationDate - Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
ExpirationDate *date.Time `json:"expirationDate,omitempty"`
}
CertificateCreateOrUpdateParameters certificate create or update details.
type CertificateCreateOrUpdateParameters struct {
// CertificateCreateOrUpdateProperties - Certificate create or update properties details.
*CertificateCreateOrUpdateProperties `json:"properties,omitempty"`
}
func (ccoup CertificateCreateOrUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CertificateCreateOrUpdateParameters.
func (ccoup *CertificateCreateOrUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CertificateCreateOrUpdateParameters struct.
CertificateCreateOrUpdateProperties parameters supplied to the CreateOrUpdate certificate operation.
type CertificateCreateOrUpdateProperties struct {
// Data - Base 64 encoded certificate using the application/x-pkcs12 representation.
Data *string `json:"data,omitempty"`
// Password - Password for the Certificate
Password *string `json:"password,omitempty"`
}
CertificateInformation SSL certificate information.
type CertificateInformation struct {
autorest.Response `json:"-"`
// Expiry - Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
Expiry *date.Time `json:"expiry,omitempty"`
// Thumbprint - Thumbprint of the certificate.
Thumbprint *string `json:"thumbprint,omitempty"`
// Subject - Subject of the certificate.
Subject *string `json:"subject,omitempty"`
}
ClientAuthenticationMethod enumerates the values for client authentication method.
type ClientAuthenticationMethod string
const (
// Basic Basic Client Authentication method.
Basic ClientAuthenticationMethod = "Basic"
// Body Body based Authentication method.
Body ClientAuthenticationMethod = "Body"
)
func PossibleClientAuthenticationMethodValues() []ClientAuthenticationMethod
PossibleClientAuthenticationMethodValues returns an array of possible values for the ClientAuthenticationMethod const type.
Confirmation enumerates the values for confirmation.
type Confirmation string
const (
// Invite Send an e-mail inviting the user to sign-up and complete registration.
Invite Confirmation = "invite"
// Signup Send an e-mail to the user confirming they have successfully signed up.
Signup Confirmation = "signup"
)
func PossibleConfirmationValues() []Confirmation
PossibleConfirmationValues returns an array of possible values for the Confirmation const type.
ConnectivityStatusContract details about connectivity to a resource.
type ConnectivityStatusContract struct {
// Name - The hostname of the resource which the service depends on. This can be the database, storage or any other azure resource on which the service depends upon.
Name *string `json:"name,omitempty"`
// Status - Resource Connectivity Status Type identifier. Possible values include: 'Initializing', 'Success', 'Failure'
Status ConnectivityStatusType `json:"status,omitempty"`
// Error - Error details of the connectivity to the resource.
Error *string `json:"error,omitempty"`
// LastUpdated - The date when the resource connectivity status was last updated. This status should be updated every 15 minutes. If this status has not been updated, then it means that the service has lost network connectivity to the resource, from inside the Virtual Network.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
LastUpdated *date.Time `json:"lastUpdated,omitempty"`
// LastStatusChange - The date when the resource connectivity status last Changed from success to failure or vice-versa. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
LastStatusChange *date.Time `json:"lastStatusChange,omitempty"`
}
ConnectivityStatusType enumerates the values for connectivity status type.
type ConnectivityStatusType string
const (
// Failure ...
Failure ConnectivityStatusType = "failure"
// Initializing ...
Initializing ConnectivityStatusType = "initializing"
// Success ...
Success ConnectivityStatusType = "success"
)
func PossibleConnectivityStatusTypeValues() []ConnectivityStatusType
PossibleConnectivityStatusTypeValues returns an array of possible values for the ConnectivityStatusType const type.
ContentFormat enumerates the values for content format.
type ContentFormat string
const (
// SwaggerJSON The contents are inline and Content Type is a OpenApi 2.0 Document.
SwaggerJSON ContentFormat = "swagger-json"
// SwaggerLinkJSON The Open Api 2.0 document is hosted on a publicly accessible internet address.
SwaggerLinkJSON ContentFormat = "swagger-link-json"
// WadlLinkJSON The WADL document is hosted on a publicly accessible internet address.
WadlLinkJSON ContentFormat = "wadl-link-json"
// WadlXML The contents are inline and Content type is a WADL document.
WadlXML ContentFormat = "wadl-xml"
// Wsdl The contents are inline and the document is a WSDL/Soap document.
Wsdl ContentFormat = "wsdl"
// WsdlLink The WSDL document is hosted on a publicly accessible internet address.
WsdlLink ContentFormat = "wsdl-link"
)
func PossibleContentFormatValues() []ContentFormat
PossibleContentFormatValues returns an array of possible values for the ContentFormat const type.
CurrentUserIdentity ...
type CurrentUserIdentity struct {
autorest.Response `json:"-"`
// ID - API Management service user id.
ID *string `json:"id,omitempty"`
}
DelegationSettingsClient is the apiManagement Client
type DelegationSettingsClient struct {
BaseClient
}
func NewDelegationSettingsClient(subscriptionID string) DelegationSettingsClient
NewDelegationSettingsClient creates an instance of the DelegationSettingsClient client.
func NewDelegationSettingsClientWithBaseURI(baseURI string, subscriptionID string) DelegationSettingsClient
NewDelegationSettingsClientWithBaseURI creates an instance of the DelegationSettingsClient 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 (client DelegationSettingsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalDelegationSettings) (result PortalDelegationSettings, err error)
CreateOrUpdate create or Update Delegation settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - create or update parameters.
func (client DelegationSettingsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalDelegationSettings) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DelegationSettingsClient) CreateOrUpdateResponder(resp *http.Response) (result PortalDelegationSettings, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DelegationSettingsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client DelegationSettingsClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result PortalDelegationSettings, err error)
Get get Delegation settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client DelegationSettingsClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the DelegationSettings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client DelegationSettingsClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client DelegationSettingsClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client DelegationSettingsClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client DelegationSettingsClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client DelegationSettingsClient) GetResponder(resp *http.Response) (result PortalDelegationSettings, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client DelegationSettingsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DelegationSettingsClient) Update(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalDelegationSettings, ifMatch string) (result autorest.Response, err error)
Update update Delegation settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - update Delegation settings. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client DelegationSettingsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalDelegationSettings, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client DelegationSettingsClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client DelegationSettingsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
DeployConfigurationParameters parameters supplied to the Deploy Configuration operation.
type DeployConfigurationParameters struct {
// Branch - The name of the Git branch from which the configuration is to be deployed to the configuration database.
Branch *string `json:"branch,omitempty"`
// Force - The value enforcing deleting subscriptions to products that are deleted in this update.
Force *bool `json:"force,omitempty"`
}
DiagnosticClient is the apiManagement Client
type DiagnosticClient struct {
BaseClient
}
func NewDiagnosticClient(subscriptionID string) DiagnosticClient
NewDiagnosticClient creates an instance of the DiagnosticClient client.
func NewDiagnosticClientWithBaseURI(baseURI string, subscriptionID string) DiagnosticClient
NewDiagnosticClientWithBaseURI creates an instance of the DiagnosticClient 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 (client DiagnosticClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, parameters DiagnosticContract, ifMatch string) (result DiagnosticContract, err error)
CreateOrUpdate creates a new Diagnostic or updates an existing one. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client DiagnosticClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, parameters DiagnosticContract, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DiagnosticClient) CreateOrUpdateResponder(resp *http.Response) (result DiagnosticContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DiagnosticClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client DiagnosticClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, ifMatch string) (result autorest.Response, err error)
Delete deletes the specified Diagnostic. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client DiagnosticClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client DiagnosticClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client DiagnosticClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client DiagnosticClient) Get(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string) (result DiagnosticContract, err error)
Get gets the details of the Diagnostic specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance.
func (client DiagnosticClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the Diagnostic specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance.
func (client DiagnosticClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client DiagnosticClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client DiagnosticClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client DiagnosticClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client DiagnosticClient) GetResponder(resp *http.Response) (result DiagnosticContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client DiagnosticClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DiagnosticClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result DiagnosticCollectionPage, err error)
ListByService lists all diagnostics of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client DiagnosticClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result DiagnosticCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client DiagnosticClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client DiagnosticClient) ListByServiceResponder(resp *http.Response) (result DiagnosticCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client DiagnosticClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
func (client DiagnosticClient) Update(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, parameters DiagnosticContract, ifMatch string) (result autorest.Response, err error)
Update updates the details of the Diagnostic specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. parameters - diagnostic Update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client DiagnosticClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, parameters DiagnosticContract, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client DiagnosticClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client DiagnosticClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
DiagnosticCollection paged Diagnostic list representation.
type DiagnosticCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]DiagnosticContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (dc DiagnosticCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
DiagnosticCollectionIterator provides access to a complete listing of DiagnosticContract values.
type DiagnosticCollectionIterator struct {
// contains filtered or unexported fields
}
func NewDiagnosticCollectionIterator(page DiagnosticCollectionPage) DiagnosticCollectionIterator
Creates a new instance of the DiagnosticCollectionIterator type.
func (iter *DiagnosticCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *DiagnosticCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter DiagnosticCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DiagnosticCollectionIterator) Response() DiagnosticCollection
Response returns the raw server response from the last page request.
func (iter DiagnosticCollectionIterator) Value() DiagnosticContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
DiagnosticCollectionPage contains a page of DiagnosticContract values.
type DiagnosticCollectionPage struct {
// contains filtered or unexported fields
}
func NewDiagnosticCollectionPage(cur DiagnosticCollection, getNextPage func(context.Context, DiagnosticCollection) (DiagnosticCollection, error)) DiagnosticCollectionPage
Creates a new instance of the DiagnosticCollectionPage type.
func (page *DiagnosticCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *DiagnosticCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page DiagnosticCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DiagnosticCollectionPage) Response() DiagnosticCollection
Response returns the raw server response from the last page request.
func (page DiagnosticCollectionPage) Values() []DiagnosticContract
Values returns the slice of values for the current page or nil if there are no values.
DiagnosticContract diagnostic details.
type DiagnosticContract struct {
autorest.Response `json:"-"`
// DiagnosticContractProperties - Diagnostic entity contract properties.
*DiagnosticContractProperties `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"`
}
func (dc DiagnosticContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiagnosticContract.
func (dc *DiagnosticContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DiagnosticContract struct.
DiagnosticContractProperties diagnostic Entity Properties
type DiagnosticContractProperties struct {
// Enabled - Indicates whether a diagnostic should receive data or not.
Enabled *bool `json:"enabled,omitempty"`
}
DiagnosticLoggerClient is the apiManagement Client
type DiagnosticLoggerClient struct {
BaseClient
}
func NewDiagnosticLoggerClient(subscriptionID string) DiagnosticLoggerClient
NewDiagnosticLoggerClient creates an instance of the DiagnosticLoggerClient client.
func NewDiagnosticLoggerClientWithBaseURI(baseURI string, subscriptionID string) DiagnosticLoggerClient
NewDiagnosticLoggerClientWithBaseURI creates an instance of the DiagnosticLoggerClient 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 (client DiagnosticLoggerClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, loggerid string) (result autorest.Response, err error)
CheckEntityExists checks that logger entity specified by identifier is associated with the diagnostics entity. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. loggerid - logger identifier. Must be unique in the API Management service instance.
func (client DiagnosticLoggerClient) CheckEntityExistsPreparer(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, loggerid string) (*http.Request, error)
CheckEntityExistsPreparer prepares the CheckEntityExists request.
func (client DiagnosticLoggerClient) CheckEntityExistsResponder(resp *http.Response) (result autorest.Response, err error)
CheckEntityExistsResponder handles the response to the CheckEntityExists request. The method always closes the http.Response Body.
func (client DiagnosticLoggerClient) CheckEntityExistsSender(req *http.Request) (*http.Response, error)
CheckEntityExistsSender sends the CheckEntityExists request. The method will close the http.Response Body if it receives an error.
func (client DiagnosticLoggerClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, loggerid string) (result LoggerContract, err error)
CreateOrUpdate attaches a logger to a diagnostic. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. loggerid - logger identifier. Must be unique in the API Management service instance.
func (client DiagnosticLoggerClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, loggerid string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DiagnosticLoggerClient) CreateOrUpdateResponder(resp *http.Response) (result LoggerContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DiagnosticLoggerClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client DiagnosticLoggerClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, loggerid string) (result autorest.Response, err error)
Delete deletes the specified Logger from Diagnostic. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. loggerid - logger identifier. Must be unique in the API Management service instance.
func (client DiagnosticLoggerClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, loggerid string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client DiagnosticLoggerClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client DiagnosticLoggerClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client DiagnosticLoggerClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, filter string, top *int32, skip *int32) (result LoggerCollectionPage, err error)
ListByService lists all loggers associated with the specified Diagnostic of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. diagnosticID - diagnostic identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | type | eq | | top - number of records to return. skip - number of records to skip.
func (client DiagnosticLoggerClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, filter string, top *int32, skip *int32) (result LoggerCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client DiagnosticLoggerClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, diagnosticID string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client DiagnosticLoggerClient) ListByServiceResponder(resp *http.Response) (result LoggerCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client DiagnosticLoggerClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
EmailTemplateClient is the apiManagement Client
type EmailTemplateClient struct {
BaseClient
}
func NewEmailTemplateClient(subscriptionID string) EmailTemplateClient
NewEmailTemplateClient creates an instance of the EmailTemplateClient client.
func NewEmailTemplateClientWithBaseURI(baseURI string, subscriptionID string) EmailTemplateClient
NewEmailTemplateClientWithBaseURI creates an instance of the EmailTemplateClient 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 (client EmailTemplateClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName, parameters EmailTemplateUpdateParameters, ifMatch string) (result EmailTemplateContract, err error)
CreateOrUpdate updates an Email Template. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. templateName - email Template Name Identifier. parameters - email Template update parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client EmailTemplateClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName, parameters EmailTemplateUpdateParameters, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client EmailTemplateClient) CreateOrUpdateResponder(resp *http.Response) (result EmailTemplateContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client EmailTemplateClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client EmailTemplateClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName, ifMatch string) (result autorest.Response, err error)
Delete reset the Email Template to default template provided by the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. templateName - email Template Name Identifier. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client EmailTemplateClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client EmailTemplateClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client EmailTemplateClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client EmailTemplateClient) Get(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName) (result EmailTemplateContract, err error)
Get gets the details of the email template specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. templateName - email Template Name Identifier.
func (client EmailTemplateClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the email template specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. templateName - email Template Name Identifier.
func (client EmailTemplateClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client EmailTemplateClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client EmailTemplateClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client EmailTemplateClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName) (*http.Request, error)
GetPreparer prepares the Get request.
func (client EmailTemplateClient) GetResponder(resp *http.Response) (result EmailTemplateContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client EmailTemplateClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client EmailTemplateClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, top *int32, skip *int32) (result EmailTemplateCollectionPage, err error)
ListByService lists a collection of properties defined within a service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. top - number of records to return. skip - number of records to skip.
func (client EmailTemplateClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, top *int32, skip *int32) (result EmailTemplateCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client EmailTemplateClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client EmailTemplateClient) ListByServiceResponder(resp *http.Response) (result EmailTemplateCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client EmailTemplateClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
func (client EmailTemplateClient) Update(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName, parameters EmailTemplateUpdateParameters) (result autorest.Response, err error)
Update updates the specific Email Template. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. templateName - email Template Name Identifier. parameters - update parameters.
func (client EmailTemplateClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, templateName TemplateName, parameters EmailTemplateUpdateParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client EmailTemplateClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client EmailTemplateClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
EmailTemplateCollection paged email template list representation.
type EmailTemplateCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]EmailTemplateContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (etc EmailTemplateCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
EmailTemplateCollectionIterator provides access to a complete listing of EmailTemplateContract values.
type EmailTemplateCollectionIterator struct {
// contains filtered or unexported fields
}
func NewEmailTemplateCollectionIterator(page EmailTemplateCollectionPage) EmailTemplateCollectionIterator
Creates a new instance of the EmailTemplateCollectionIterator type.
func (iter *EmailTemplateCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *EmailTemplateCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter EmailTemplateCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter EmailTemplateCollectionIterator) Response() EmailTemplateCollection
Response returns the raw server response from the last page request.
func (iter EmailTemplateCollectionIterator) Value() EmailTemplateContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
EmailTemplateCollectionPage contains a page of EmailTemplateContract values.
type EmailTemplateCollectionPage struct {
// contains filtered or unexported fields
}
func NewEmailTemplateCollectionPage(cur EmailTemplateCollection, getNextPage func(context.Context, EmailTemplateCollection) (EmailTemplateCollection, error)) EmailTemplateCollectionPage
Creates a new instance of the EmailTemplateCollectionPage type.
func (page *EmailTemplateCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *EmailTemplateCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page EmailTemplateCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page EmailTemplateCollectionPage) Response() EmailTemplateCollection
Response returns the raw server response from the last page request.
func (page EmailTemplateCollectionPage) Values() []EmailTemplateContract
Values returns the slice of values for the current page or nil if there are no values.
EmailTemplateContract email Template details.
type EmailTemplateContract struct {
autorest.Response `json:"-"`
// EmailTemplateContractProperties - Email Template entity contract properties.
*EmailTemplateContractProperties `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"`
}
func (etc EmailTemplateContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EmailTemplateContract.
func (etc *EmailTemplateContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for EmailTemplateContract struct.
EmailTemplateContractProperties email Template Contract properties.
type EmailTemplateContractProperties struct {
// Subject - Subject of the Template.
Subject *string `json:"subject,omitempty"`
// Body - Email Template Body. This should be a valid XDocument
Body *string `json:"body,omitempty"`
// Title - Title of the Template.
Title *string `json:"title,omitempty"`
// Description - Description of the Email Template.
Description *string `json:"description,omitempty"`
// IsDefault - READ-ONLY; Whether the template is the default template provided by Api Management or has been edited.
IsDefault *bool `json:"isDefault,omitempty"`
// Parameters - Email Template Parameter values.
Parameters *[]EmailTemplateParametersContractProperties `json:"parameters,omitempty"`
}
func (etcp EmailTemplateContractProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EmailTemplateContractProperties.
EmailTemplateParametersContractProperties email Template Parameter contract.
type EmailTemplateParametersContractProperties struct {
// Name - Template parameter name.
Name *string `json:"name,omitempty"`
// Title - Template parameter title.
Title *string `json:"title,omitempty"`
// Description - Template parameter description.
Description *string `json:"description,omitempty"`
}
EmailTemplateUpdateParameterProperties email Template Update Contract properties.
type EmailTemplateUpdateParameterProperties struct {
// Subject - Subject of the Template.
Subject *string `json:"subject,omitempty"`
// Title - Title of the Template.
Title *string `json:"title,omitempty"`
// Description - Description of the Email Template.
Description *string `json:"description,omitempty"`
// Body - Email Template Body. This should be a valid XDocument
Body *string `json:"body,omitempty"`
// Parameters - Email Template Parameter values.
Parameters *[]EmailTemplateParametersContractProperties `json:"parameters,omitempty"`
}
EmailTemplateUpdateParameters email Template update Parameters.
type EmailTemplateUpdateParameters struct {
// EmailTemplateUpdateParameterProperties - Email Template Update contract properties.
*EmailTemplateUpdateParameterProperties `json:"properties,omitempty"`
}
func (etup EmailTemplateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EmailTemplateUpdateParameters.
func (etup *EmailTemplateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for EmailTemplateUpdateParameters struct.
ErrorFieldContract error Field contract.
type ErrorFieldContract struct {
// Code - Property level error code.
Code *string `json:"code,omitempty"`
// Message - Human-readable representation of property-level error.
Message *string `json:"message,omitempty"`
// Target - Property name.
Target *string `json:"target,omitempty"`
}
ErrorResponse error Response.
type ErrorResponse struct {
// ErrorResponseBody - Properties of the Error Response.
*ErrorResponseBody `json:"error,omitempty"`
}
func (er ErrorResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorResponse.
func (er *ErrorResponse) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ErrorResponse struct.
ErrorResponseBody error Body contract.
type ErrorResponseBody struct {
// Code - Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
Code *string `json:"code,omitempty"`
// Message - Human-readable representation of the error.
Message *string `json:"message,omitempty"`
// Details - The list of invalid fields send in request, in case of validation error.
Details *[]ErrorFieldContract `json:"details,omitempty"`
}
ExportFormat enumerates the values for export format.
type ExportFormat string
const (
// ExportFormatSwagger Export the Api Definition in OpenApi Specification 2.0 format to the Storage Blob.
ExportFormatSwagger ExportFormat = "swagger-link"
// ExportFormatWadl Export the Api Definition in WADL Schema to Storage Blob.
ExportFormatWadl ExportFormat = "wadl-link"
// ExportFormatWsdl Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for
// APIs of Type `soap`
ExportFormatWsdl ExportFormat = "wsdl-link"
)
func PossibleExportFormatValues() []ExportFormat
PossibleExportFormatValues returns an array of possible values for the ExportFormat const type.
GenerateSsoURLResult generate SSO Url operations response details.
type GenerateSsoURLResult struct {
autorest.Response `json:"-"`
// Value - Redirect Url containing the SSO URL value.
Value *string `json:"value,omitempty"`
}
GrantType enumerates the values for grant type.
type GrantType string
const (
// AuthorizationCode Authorization Code Grant flow as described
// https://tools.ietf.org/html/rfc6749#section-4.1.
AuthorizationCode GrantType = "authorizationCode"
// ClientCredentials Client Credentials Grant flow as described
// https://tools.ietf.org/html/rfc6749#section-4.4.
ClientCredentials GrantType = "clientCredentials"
// Implicit Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2.
Implicit GrantType = "implicit"
// ResourceOwnerPassword Resource Owner Password Grant flow as described
// https://tools.ietf.org/html/rfc6749#section-4.3.
ResourceOwnerPassword GrantType = "resourceOwnerPassword"
)
func PossibleGrantTypeValues() []GrantType
PossibleGrantTypeValues returns an array of possible values for the GrantType const type.
GroupClient is the apiManagement Client
type GroupClient struct {
BaseClient
}
func NewGroupClient(subscriptionID string) GroupClient
NewGroupClient creates an instance of the GroupClient client.
func NewGroupClientWithBaseURI(baseURI string, subscriptionID string) GroupClient
NewGroupClientWithBaseURI creates an instance of the GroupClient 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 (client GroupClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, groupID string, parameters GroupCreateParameters, ifMatch string) (result GroupContract, err error)
CreateOrUpdate creates or Updates a group. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client GroupClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string, parameters GroupCreateParameters, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client GroupClient) CreateOrUpdateResponder(resp *http.Response) (result GroupContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client GroupClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client GroupClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, groupID string, ifMatch string) (result autorest.Response, err error)
Delete deletes specific group of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client GroupClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client GroupClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client GroupClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client GroupClient) Get(ctx context.Context, resourceGroupName string, serviceName string, groupID string) (result GroupContract, err error)
Get gets the details of the group specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance.
func (client GroupClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, groupID string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the group specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance.
func (client GroupClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client GroupClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client GroupClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client GroupClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client GroupClient) GetResponder(resp *http.Response) (result GroupContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client GroupClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client GroupClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result GroupCollectionPage, err error)
ListByService lists a collection of groups defined within a service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | type | eq, ne | N/A | top - number of records to return. skip - number of records to skip.
func (client GroupClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result GroupCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client GroupClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client GroupClient) ListByServiceResponder(resp *http.Response) (result GroupCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client GroupClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
func (client GroupClient) Update(ctx context.Context, resourceGroupName string, serviceName string, groupID string, parameters GroupUpdateParameters, ifMatch string) (result autorest.Response, err error)
Update updates the details of the group specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client GroupClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string, parameters GroupUpdateParameters, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client GroupClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client GroupClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
GroupCollection paged Group list representation.
type GroupCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]GroupContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (gc GroupCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
GroupCollectionIterator provides access to a complete listing of GroupContract values.
type GroupCollectionIterator struct {
// contains filtered or unexported fields
}
func NewGroupCollectionIterator(page GroupCollectionPage) GroupCollectionIterator
Creates a new instance of the GroupCollectionIterator type.
func (iter *GroupCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *GroupCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter GroupCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter GroupCollectionIterator) Response() GroupCollection
Response returns the raw server response from the last page request.
func (iter GroupCollectionIterator) Value() GroupContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
GroupCollectionPage contains a page of GroupContract values.
type GroupCollectionPage struct {
// contains filtered or unexported fields
}
func NewGroupCollectionPage(cur GroupCollection, getNextPage func(context.Context, GroupCollection) (GroupCollection, error)) GroupCollectionPage
Creates a new instance of the GroupCollectionPage type.
func (page *GroupCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *GroupCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page GroupCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page GroupCollectionPage) Response() GroupCollection
Response returns the raw server response from the last page request.
func (page GroupCollectionPage) Values() []GroupContract
Values returns the slice of values for the current page or nil if there are no values.
GroupContract contract details.
type GroupContract struct {
autorest.Response `json:"-"`
// GroupContractProperties - Group entity contract properties.
*GroupContractProperties `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"`
}
func (gc GroupContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GroupContract.
func (gc *GroupContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GroupContract struct.
GroupContractProperties group contract Properties.
type GroupContractProperties struct {
// DisplayName - Group name.
DisplayName *string `json:"displayName,omitempty"`
// Description - Group description. Can contain HTML formatting tags.
Description *string `json:"description,omitempty"`
// BuiltIn - READ-ONLY; true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
BuiltIn *bool `json:"builtIn,omitempty"`
// Type - Group type. Possible values include: 'Custom', 'System', 'External'
Type GroupType `json:"type,omitempty"`
// ExternalID - For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
ExternalID *string `json:"externalId,omitempty"`
}
func (gcp GroupContractProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GroupContractProperties.
GroupCreateParameters parameters supplied to the Create Group operation.
type GroupCreateParameters struct {
// GroupCreateParametersProperties - Properties supplied to Create Group operation.
*GroupCreateParametersProperties `json:"properties,omitempty"`
}
func (gcp GroupCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GroupCreateParameters.
func (gcp *GroupCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GroupCreateParameters struct.
GroupCreateParametersProperties parameters supplied to the Create Group operation.
type GroupCreateParametersProperties struct {
// DisplayName - Group name.
DisplayName *string `json:"displayName,omitempty"`
// Description - Group description.
Description *string `json:"description,omitempty"`
// Type - Group type. Possible values include: 'Custom', 'System', 'External'
Type GroupType `json:"type,omitempty"`
// ExternalID - Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
ExternalID *string `json:"externalId,omitempty"`
}
GroupType enumerates the values for group type.
type GroupType string
const (
// Custom ...
Custom GroupType = "custom"
// External ...
External GroupType = "external"
// System ...
System GroupType = "system"
)
func PossibleGroupTypeValues() []GroupType
PossibleGroupTypeValues returns an array of possible values for the GroupType const type.
GroupUpdateParameters parameters supplied to the Update Group operation.
type GroupUpdateParameters struct {
// GroupUpdateParametersProperties - Group entity update contract properties.
*GroupUpdateParametersProperties `json:"properties,omitempty"`
}
func (gup GroupUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GroupUpdateParameters.
func (gup *GroupUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GroupUpdateParameters struct.
GroupUpdateParametersProperties parameters supplied to the Update Group operation.
type GroupUpdateParametersProperties struct {
// DisplayName - Group name.
DisplayName *string `json:"displayName,omitempty"`
// Description - Group description.
Description *string `json:"description,omitempty"`
// Type - Group type. Possible values include: 'Custom', 'System', 'External'
Type GroupType `json:"type,omitempty"`
// ExternalID - Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
ExternalID *string `json:"externalId,omitempty"`
}
GroupUserClient is the apiManagement Client
type GroupUserClient struct {
BaseClient
}
func NewGroupUserClient(subscriptionID string) GroupUserClient
NewGroupUserClient creates an instance of the GroupUserClient client.
func NewGroupUserClientWithBaseURI(baseURI string, subscriptionID string) GroupUserClient
NewGroupUserClientWithBaseURI creates an instance of the GroupUserClient 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 (client GroupUserClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, groupID string, UID string) (result autorest.Response, err error)
CheckEntityExists checks that user entity specified by identifier is associated with the group entity. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. UID - user identifier. Must be unique in the current API Management service instance.
func (client GroupUserClient) CheckEntityExistsPreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string, UID string) (*http.Request, error)
CheckEntityExistsPreparer prepares the CheckEntityExists request.
func (client GroupUserClient) CheckEntityExistsResponder(resp *http.Response) (result autorest.Response, err error)
CheckEntityExistsResponder handles the response to the CheckEntityExists request. The method always closes the http.Response Body.
func (client GroupUserClient) CheckEntityExistsSender(req *http.Request) (*http.Response, error)
CheckEntityExistsSender sends the CheckEntityExists request. The method will close the http.Response Body if it receives an error.
func (client GroupUserClient) Create(ctx context.Context, resourceGroupName string, serviceName string, groupID string, UID string) (result UserContract, err error)
Create adds a user to the specified group. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. UID - user identifier. Must be unique in the current API Management service instance.
func (client GroupUserClient) CreatePreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string, UID string) (*http.Request, error)
CreatePreparer prepares the Create request.
func (client GroupUserClient) CreateResponder(resp *http.Response) (result UserContract, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (client GroupUserClient) CreateSender(req *http.Request) (*http.Response, error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (client GroupUserClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, groupID string, UID string) (result autorest.Response, err error)
Delete remove existing user from existing group. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. UID - user identifier. Must be unique in the current API Management service instance.
func (client GroupUserClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string, UID string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client GroupUserClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client GroupUserClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client GroupUserClient) List(ctx context.Context, resourceGroupName string, serviceName string, groupID string, filter string, top *int32, skip *int32) (result UserCollectionPage, err error)
List lists a collection of the members of the group, specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. groupID - group identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |------------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | N/A | | registrationDate | ge, le, eq, ne, gt, lt | N/A | | note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client GroupUserClient) ListComplete(ctx context.Context, resourceGroupName string, serviceName string, groupID string, filter string, top *int32, skip *int32) (result UserCollectionIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client GroupUserClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string, groupID string, filter string, top *int32, skip *int32) (*http.Request, error)
ListPreparer prepares the List request.
func (client GroupUserClient) ListResponder(resp *http.Response) (result UserCollection, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client GroupUserClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
HostnameConfiguration custom hostname configuration.
type HostnameConfiguration struct {
// Type - Hostname type. Possible values include: 'Proxy', 'Portal', 'Management', 'Scm'
Type HostnameType `json:"type,omitempty"`
// HostName - Hostname to configure on the Api Management service.
HostName *string `json:"hostName,omitempty"`
// KeyVaultID - Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with MSI. The secret should be of type *application/x-pkcs12*
KeyVaultID *string `json:"keyVaultId,omitempty"`
// EncodedCertificate - Base64 Encoded certificate.
EncodedCertificate *string `json:"encodedCertificate,omitempty"`
// CertificatePassword - Certificate Password.
CertificatePassword *string `json:"certificatePassword,omitempty"`
// DefaultSslBinding - Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to Proxy Hostname Type.
DefaultSslBinding *bool `json:"defaultSslBinding,omitempty"`
// NegotiateClientCertificate - Specify true to always negotiate client certificate on the hostname. Default Value is false.
NegotiateClientCertificate *bool `json:"negotiateClientCertificate,omitempty"`
// Certificate - Certificate information.
Certificate *CertificateInformation `json:"certificate,omitempty"`
}
HostnameConfigurationOld custom hostname configuration.
type HostnameConfigurationOld struct {
// Type - Hostname type. Possible values include: 'Proxy', 'Portal', 'Management', 'Scm'
Type HostnameType `json:"type,omitempty"`
// Hostname - Hostname to configure.
Hostname *string `json:"hostname,omitempty"`
// Certificate - Certificate information.
Certificate *CertificateInformation `json:"certificate,omitempty"`
}
HostnameType enumerates the values for hostname type.
type HostnameType string
const (
// Management ...
Management HostnameType = "Management"
// Portal ...
Portal HostnameType = "Portal"
// Proxy ...
Proxy HostnameType = "Proxy"
// Scm ...
Scm HostnameType = "Scm"
)
func PossibleHostnameTypeValues() []HostnameType
PossibleHostnameTypeValues returns an array of possible values for the HostnameType const type.
IdentityProviderBaseParameters identity Provider Base Parameter Properties.
type IdentityProviderBaseParameters struct {
// Type - Identity Provider Type identifier. Possible values include: 'Facebook', 'Google', 'Microsoft', 'Twitter', 'Aad', 'AadB2C'
Type IdentityProviderType `json:"type,omitempty"`
// AllowedTenants - List of Allowed Tenants when configuring Azure Active Directory login.
AllowedTenants *[]string `json:"allowedTenants,omitempty"`
// SignupPolicyName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
SignupPolicyName *string `json:"signupPolicyName,omitempty"`
// SigninPolicyName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
SigninPolicyName *string `json:"signinPolicyName,omitempty"`
// ProfileEditingPolicyName - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
ProfileEditingPolicyName *string `json:"profileEditingPolicyName,omitempty"`
// PasswordResetPolicyName - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
PasswordResetPolicyName *string `json:"passwordResetPolicyName,omitempty"`
}
IdentityProviderClient is the apiManagement Client
type IdentityProviderClient struct {
BaseClient
}
func NewIdentityProviderClient(subscriptionID string) IdentityProviderClient
NewIdentityProviderClient creates an instance of the IdentityProviderClient client.
func NewIdentityProviderClientWithBaseURI(baseURI string, subscriptionID string) IdentityProviderClient
NewIdentityProviderClientWithBaseURI creates an instance of the IdentityProviderClient 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 (client IdentityProviderClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType, parameters IdentityProviderContract, ifMatch string) (result IdentityProviderContract, err error)
CreateOrUpdate creates or Updates the IdentityProvider configuration. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. identityProviderName - identity Provider Type identifier. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client IdentityProviderClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType, parameters IdentityProviderContract, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client IdentityProviderClient) CreateOrUpdateResponder(resp *http.Response) (result IdentityProviderContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client IdentityProviderClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client IdentityProviderClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType, ifMatch string) (result autorest.Response, err error)
Delete deletes the specified identity provider configuration. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. identityProviderName - identity Provider Type identifier. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client IdentityProviderClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client IdentityProviderClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client IdentityProviderClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client IdentityProviderClient) Get(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType) (result IdentityProviderContract, err error)
Get gets the configuration details of the identity Provider configured in specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. identityProviderName - identity Provider Type identifier.
func (client IdentityProviderClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the identityProvider specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. identityProviderName - identity Provider Type identifier.
func (client IdentityProviderClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client IdentityProviderClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client IdentityProviderClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client IdentityProviderClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType) (*http.Request, error)
GetPreparer prepares the Get request.
func (client IdentityProviderClient) GetResponder(resp *http.Response) (result IdentityProviderContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client IdentityProviderClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client IdentityProviderClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string) (result IdentityProviderListPage, err error)
ListByService lists a collection of Identity Provider configured in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client IdentityProviderClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string) (result IdentityProviderListIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client IdentityProviderClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client IdentityProviderClient) ListByServiceResponder(resp *http.Response) (result IdentityProviderList, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client IdentityProviderClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
func (client IdentityProviderClient) Update(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType, parameters IdentityProviderUpdateParameters, ifMatch string) (result autorest.Response, err error)
Update updates an existing IdentityProvider configuration. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. identityProviderName - identity Provider Type identifier. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client IdentityProviderClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, identityProviderName IdentityProviderType, parameters IdentityProviderUpdateParameters, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client IdentityProviderClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client IdentityProviderClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
IdentityProviderContract identity Provider details.
type IdentityProviderContract struct {
autorest.Response `json:"-"`
// IdentityProviderContractProperties - Identity Provider contract properties.
*IdentityProviderContractProperties `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"`
}
func (ipc IdentityProviderContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IdentityProviderContract.
func (ipc *IdentityProviderContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for IdentityProviderContract struct.
IdentityProviderContractProperties the external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.
type IdentityProviderContractProperties struct {
// ClientID - Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
ClientID *string `json:"clientId,omitempty"`
// ClientSecret - Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.
ClientSecret *string `json:"clientSecret,omitempty"`
// Type - Identity Provider Type identifier. Possible values include: 'Facebook', 'Google', 'Microsoft', 'Twitter', 'Aad', 'AadB2C'
Type IdentityProviderType `json:"type,omitempty"`
// AllowedTenants - List of Allowed Tenants when configuring Azure Active Directory login.
AllowedTenants *[]string `json:"allowedTenants,omitempty"`
// SignupPolicyName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
SignupPolicyName *string `json:"signupPolicyName,omitempty"`
// SigninPolicyName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
SigninPolicyName *string `json:"signinPolicyName,omitempty"`
// ProfileEditingPolicyName - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
ProfileEditingPolicyName *string `json:"profileEditingPolicyName,omitempty"`
// PasswordResetPolicyName - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
PasswordResetPolicyName *string `json:"passwordResetPolicyName,omitempty"`
}
IdentityProviderList list of all the Identity Providers configured on the service instance.
type IdentityProviderList struct {
autorest.Response `json:"-"`
// Value - Identity Provider configuration values.
Value *[]IdentityProviderContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (ipl IdentityProviderList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
IdentityProviderListIterator provides access to a complete listing of IdentityProviderContract values.
type IdentityProviderListIterator struct {
// contains filtered or unexported fields
}
func NewIdentityProviderListIterator(page IdentityProviderListPage) IdentityProviderListIterator
Creates a new instance of the IdentityProviderListIterator type.
func (iter *IdentityProviderListIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *IdentityProviderListIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter IdentityProviderListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter IdentityProviderListIterator) Response() IdentityProviderList
Response returns the raw server response from the last page request.
func (iter IdentityProviderListIterator) Value() IdentityProviderContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
IdentityProviderListPage contains a page of IdentityProviderContract values.
type IdentityProviderListPage struct {
// contains filtered or unexported fields
}
func NewIdentityProviderListPage(cur IdentityProviderList, getNextPage func(context.Context, IdentityProviderList) (IdentityProviderList, error)) IdentityProviderListPage
Creates a new instance of the IdentityProviderListPage type.
func (page *IdentityProviderListPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *IdentityProviderListPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page IdentityProviderListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page IdentityProviderListPage) Response() IdentityProviderList
Response returns the raw server response from the last page request.
func (page IdentityProviderListPage) Values() []IdentityProviderContract
Values returns the slice of values for the current page or nil if there are no values.
IdentityProviderType enumerates the values for identity provider type.
type IdentityProviderType string
const (
// Aad Azure Active Directory as Identity provider.
Aad IdentityProviderType = "aad"
// AadB2C Azure Active Directory B2C as Identity provider.
AadB2C IdentityProviderType = "aadB2C"
// Facebook Facebook as Identity provider.
Facebook IdentityProviderType = "facebook"
// Google Google as Identity provider.
Google IdentityProviderType = "google"
// Microsoft Microsoft Live as Identity provider.
Microsoft IdentityProviderType = "microsoft"
// Twitter Twitter as Identity provider.
Twitter IdentityProviderType = "twitter"
)
func PossibleIdentityProviderTypeValues() []IdentityProviderType
PossibleIdentityProviderTypeValues returns an array of possible values for the IdentityProviderType const type.
IdentityProviderUpdateParameters parameters supplied to update Identity Provider
type IdentityProviderUpdateParameters struct {
// IdentityProviderUpdateProperties - Identity Provider update properties.
*IdentityProviderUpdateProperties `json:"properties,omitempty"`
}
func (ipup IdentityProviderUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IdentityProviderUpdateParameters.
func (ipup *IdentityProviderUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for IdentityProviderUpdateParameters struct.
IdentityProviderUpdateProperties parameters supplied to the Update Identity Provider operation.
type IdentityProviderUpdateProperties struct {
// ClientID - Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
ClientID *string `json:"clientId,omitempty"`
// ClientSecret - Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.
ClientSecret *string `json:"clientSecret,omitempty"`
// Type - Identity Provider Type identifier. Possible values include: 'Facebook', 'Google', 'Microsoft', 'Twitter', 'Aad', 'AadB2C'
Type IdentityProviderType `json:"type,omitempty"`
// AllowedTenants - List of Allowed Tenants when configuring Azure Active Directory login.
AllowedTenants *[]string `json:"allowedTenants,omitempty"`
// SignupPolicyName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
SignupPolicyName *string `json:"signupPolicyName,omitempty"`
// SigninPolicyName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
SigninPolicyName *string `json:"signinPolicyName,omitempty"`
// ProfileEditingPolicyName - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
ProfileEditingPolicyName *string `json:"profileEditingPolicyName,omitempty"`
// PasswordResetPolicyName - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
PasswordResetPolicyName *string `json:"passwordResetPolicyName,omitempty"`
}
IssueAttachmentCollection paged Issue Attachment list representation.
type IssueAttachmentCollection struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; Issue Attachment values.
Value *[]IssueAttachmentContract `json:"value,omitempty"`
// NextLink - READ-ONLY; Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (iac IssueAttachmentCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (iac IssueAttachmentCollection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IssueAttachmentCollection.
IssueAttachmentCollectionIterator provides access to a complete listing of IssueAttachmentContract values.
type IssueAttachmentCollectionIterator struct {
// contains filtered or unexported fields
}
func NewIssueAttachmentCollectionIterator(page IssueAttachmentCollectionPage) IssueAttachmentCollectionIterator
Creates a new instance of the IssueAttachmentCollectionIterator type.
func (iter *IssueAttachmentCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *IssueAttachmentCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter IssueAttachmentCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter IssueAttachmentCollectionIterator) Response() IssueAttachmentCollection
Response returns the raw server response from the last page request.
func (iter IssueAttachmentCollectionIterator) Value() IssueAttachmentContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
IssueAttachmentCollectionPage contains a page of IssueAttachmentContract values.
type IssueAttachmentCollectionPage struct {
// contains filtered or unexported fields
}
func NewIssueAttachmentCollectionPage(cur IssueAttachmentCollection, getNextPage func(context.Context, IssueAttachmentCollection) (IssueAttachmentCollection, error)) IssueAttachmentCollectionPage
Creates a new instance of the IssueAttachmentCollectionPage type.
func (page *IssueAttachmentCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *IssueAttachmentCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page IssueAttachmentCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page IssueAttachmentCollectionPage) Response() IssueAttachmentCollection
Response returns the raw server response from the last page request.
func (page IssueAttachmentCollectionPage) Values() []IssueAttachmentContract
Values returns the slice of values for the current page or nil if there are no values.
IssueAttachmentContract issue Attachment Contract details.
type IssueAttachmentContract struct {
autorest.Response `json:"-"`
// IssueAttachmentContractProperties - Properties of the Issue Attachment.
*IssueAttachmentContractProperties `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"`
}
func (iac IssueAttachmentContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IssueAttachmentContract.
func (iac *IssueAttachmentContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for IssueAttachmentContract struct.
IssueAttachmentContractProperties issue Attachment contract Properties.
type IssueAttachmentContractProperties struct {
// Title - Filename by which the binary data will be saved.
Title *string `json:"title,omitempty"`
// ContentFormat - Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.
ContentFormat *string `json:"contentFormat,omitempty"`
// Content - An HTTP link or Base64-encoded binary data.
Content *string `json:"content,omitempty"`
}
IssueCollection paged Issue list representation.
type IssueCollection struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; Issue values.
Value *[]IssueContract `json:"value,omitempty"`
// NextLink - READ-ONLY; Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (ic IssueCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (ic IssueCollection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IssueCollection.
IssueCollectionIterator provides access to a complete listing of IssueContract values.
type IssueCollectionIterator struct {
// contains filtered or unexported fields
}
func NewIssueCollectionIterator(page IssueCollectionPage) IssueCollectionIterator
Creates a new instance of the IssueCollectionIterator type.
func (iter *IssueCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *IssueCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter IssueCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter IssueCollectionIterator) Response() IssueCollection
Response returns the raw server response from the last page request.
func (iter IssueCollectionIterator) Value() IssueContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
IssueCollectionPage contains a page of IssueContract values.
type IssueCollectionPage struct {
// contains filtered or unexported fields
}
func NewIssueCollectionPage(cur IssueCollection, getNextPage func(context.Context, IssueCollection) (IssueCollection, error)) IssueCollectionPage
Creates a new instance of the IssueCollectionPage type.
func (page *IssueCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *IssueCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page IssueCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page IssueCollectionPage) Response() IssueCollection
Response returns the raw server response from the last page request.
func (page IssueCollectionPage) Values() []IssueContract
Values returns the slice of values for the current page or nil if there are no values.
IssueCommentCollection paged Issue Comment list representation.
type IssueCommentCollection struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; Issue Comment values.
Value *[]IssueCommentContract `json:"value,omitempty"`
// NextLink - READ-ONLY; Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (icc IssueCommentCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (icc IssueCommentCollection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IssueCommentCollection.
IssueCommentCollectionIterator provides access to a complete listing of IssueCommentContract values.
type IssueCommentCollectionIterator struct {
// contains filtered or unexported fields
}
func NewIssueCommentCollectionIterator(page IssueCommentCollectionPage) IssueCommentCollectionIterator
Creates a new instance of the IssueCommentCollectionIterator type.
func (iter *IssueCommentCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *IssueCommentCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter IssueCommentCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter IssueCommentCollectionIterator) Response() IssueCommentCollection
Response returns the raw server response from the last page request.
func (iter IssueCommentCollectionIterator) Value() IssueCommentContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
IssueCommentCollectionPage contains a page of IssueCommentContract values.
type IssueCommentCollectionPage struct {
// contains filtered or unexported fields
}
func NewIssueCommentCollectionPage(cur IssueCommentCollection, getNextPage func(context.Context, IssueCommentCollection) (IssueCommentCollection, error)) IssueCommentCollectionPage
Creates a new instance of the IssueCommentCollectionPage type.
func (page *IssueCommentCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *IssueCommentCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page IssueCommentCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page IssueCommentCollectionPage) Response() IssueCommentCollection
Response returns the raw server response from the last page request.
func (page IssueCommentCollectionPage) Values() []IssueCommentContract
Values returns the slice of values for the current page or nil if there are no values.
IssueCommentContract issue Comment Contract details.
type IssueCommentContract struct {
autorest.Response `json:"-"`
// IssueCommentContractProperties - Properties of the Issue Comment.
*IssueCommentContractProperties `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"`
}
func (icc IssueCommentContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IssueCommentContract.
func (icc *IssueCommentContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for IssueCommentContract struct.
IssueCommentContractProperties issue Comment contract Properties.
type IssueCommentContractProperties struct {
// Text - Comment text.
Text *string `json:"text,omitempty"`
// CreatedDate - Date and time when the comment was created.
CreatedDate *date.Time `json:"createdDate,omitempty"`
// UserID - A resource identifier for the user who left the comment.
UserID *string `json:"userId,omitempty"`
}
IssueContract issue Contract details.
type IssueContract struct {
autorest.Response `json:"-"`
// IssueContractProperties - Properties of the Issue.
*IssueContractProperties `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"`
}
func (ic IssueContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IssueContract.
func (ic *IssueContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for IssueContract struct.
IssueContractBaseProperties issue contract Base Properties.
type IssueContractBaseProperties struct {
// CreatedDate - Date and time when the issue was created.
CreatedDate *date.Time `json:"createdDate,omitempty"`
// State - Status of the issue. Possible values include: 'Proposed', 'Open', 'Removed', 'Resolved', 'Closed'
State State `json:"state,omitempty"`
// APIID - A resource identifier for the API the issue was created for.
APIID *string `json:"apiId,omitempty"`
}
IssueContractProperties issue contract Properties.
type IssueContractProperties struct {
// Title - The issue title.
Title *string `json:"title,omitempty"`
// Description - Text describing the issue.
Description *string `json:"description,omitempty"`
// UserID - A resource identifier for the user created the issue.
UserID *string `json:"userId,omitempty"`
// CreatedDate - Date and time when the issue was created.
CreatedDate *date.Time `json:"createdDate,omitempty"`
// State - Status of the issue. Possible values include: 'Proposed', 'Open', 'Removed', 'Resolved', 'Closed'
State State `json:"state,omitempty"`
// APIID - A resource identifier for the API the issue was created for.
APIID *string `json:"apiId,omitempty"`
}
IssueUpdateContract issue update Parameters.
type IssueUpdateContract struct {
// IssueUpdateContractProperties - Issue entity Update contract properties.
*IssueUpdateContractProperties `json:"properties,omitempty"`
}
func (iuc IssueUpdateContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IssueUpdateContract.
func (iuc *IssueUpdateContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for IssueUpdateContract struct.
IssueUpdateContractProperties issue contract Update Properties.
type IssueUpdateContractProperties struct {
// Title - The issue title.
Title *string `json:"title,omitempty"`
// Description - Text describing the issue.
Description *string `json:"description,omitempty"`
// UserID - A resource identifier for the user created the issue.
UserID *string `json:"userId,omitempty"`
// CreatedDate - Date and time when the issue was created.
CreatedDate *date.Time `json:"createdDate,omitempty"`
// State - Status of the issue. Possible values include: 'Proposed', 'Open', 'Removed', 'Resolved', 'Closed'
State State `json:"state,omitempty"`
// APIID - A resource identifier for the API the issue was created for.
APIID *string `json:"apiId,omitempty"`
}
KeyType enumerates the values for key type.
type KeyType string
const (
// Primary ...
Primary KeyType = "primary"
// Secondary ...
Secondary KeyType = "secondary"
)
func PossibleKeyTypeValues() []KeyType
PossibleKeyTypeValues returns an array of possible values for the KeyType const type.
ListNetworkStatusContractByLocation ...
type ListNetworkStatusContractByLocation struct {
autorest.Response `json:"-"`
Value *[]NetworkStatusContractByLocation `json:"value,omitempty"`
}
LoggerClient is the apiManagement Client
type LoggerClient struct {
BaseClient
}
func NewLoggerClient(subscriptionID string) LoggerClient
NewLoggerClient creates an instance of the LoggerClient client.
func NewLoggerClientWithBaseURI(baseURI string, subscriptionID string) LoggerClient
NewLoggerClientWithBaseURI creates an instance of the LoggerClient 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 (client LoggerClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, loggerid string, parameters LoggerContract, ifMatch string) (result LoggerContract, err error)
CreateOrUpdate creates or Updates a logger. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. loggerid - logger identifier. Must be unique in the API Management service instance. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client LoggerClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, loggerid string, parameters LoggerContract, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client LoggerClient) CreateOrUpdateResponder(resp *http.Response) (result LoggerContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client LoggerClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client LoggerClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, loggerid string, ifMatch string) (result autorest.Response, err error)
Delete deletes the specified logger. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. loggerid - logger identifier. Must be unique in the API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client LoggerClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, loggerid string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client LoggerClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client LoggerClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client LoggerClient) Get(ctx context.Context, resourceGroupName string, serviceName string, loggerid string) (result LoggerContract, err error)
Get gets the details of the logger specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. loggerid - logger identifier. Must be unique in the API Management service instance.
func (client LoggerClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, loggerid string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the logger specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. loggerid - logger identifier. Must be unique in the API Management service instance.
func (client LoggerClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, loggerid string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client LoggerClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client LoggerClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client LoggerClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, loggerid string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client LoggerClient) GetResponder(resp *http.Response) (result LoggerContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client LoggerClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client LoggerClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result LoggerCollectionPage, err error)
ListByService lists a collection of loggers in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | type | eq | | top - number of records to return. skip - number of records to skip.
func (client LoggerClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result LoggerCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client LoggerClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client LoggerClient) ListByServiceResponder(resp *http.Response) (result LoggerCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client LoggerClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
func (client LoggerClient) Update(ctx context.Context, resourceGroupName string, serviceName string, loggerid string, parameters LoggerUpdateContract, ifMatch string) (result autorest.Response, err error)
Update updates an existing logger. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. loggerid - logger identifier. Must be unique in the API Management service instance. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client LoggerClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, loggerid string, parameters LoggerUpdateContract, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client LoggerClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client LoggerClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
LoggerCollection paged Logger list representation.
type LoggerCollection struct {
autorest.Response `json:"-"`
// Value - Logger values.
Value *[]LoggerContract `json:"value,omitempty"`
// Count - Total record count number across all pages.
Count *int64 `json:"count,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (lc LoggerCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
LoggerCollectionIterator provides access to a complete listing of LoggerContract values.
type LoggerCollectionIterator struct {
// contains filtered or unexported fields
}
func NewLoggerCollectionIterator(page LoggerCollectionPage) LoggerCollectionIterator
Creates a new instance of the LoggerCollectionIterator type.
func (iter *LoggerCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *LoggerCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter LoggerCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter LoggerCollectionIterator) Response() LoggerCollection
Response returns the raw server response from the last page request.
func (iter LoggerCollectionIterator) Value() LoggerContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
LoggerCollectionPage contains a page of LoggerContract values.
type LoggerCollectionPage struct {
// contains filtered or unexported fields
}
func NewLoggerCollectionPage(cur LoggerCollection, getNextPage func(context.Context, LoggerCollection) (LoggerCollection, error)) LoggerCollectionPage
Creates a new instance of the LoggerCollectionPage type.
func (page *LoggerCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *LoggerCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page LoggerCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page LoggerCollectionPage) Response() LoggerCollection
Response returns the raw server response from the last page request.
func (page LoggerCollectionPage) Values() []LoggerContract
Values returns the slice of values for the current page or nil if there are no values.
LoggerContract logger details.
type LoggerContract struct {
autorest.Response `json:"-"`
// LoggerContractProperties - Logger entity contract properties.
*LoggerContractProperties `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"`
}
func (lc LoggerContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LoggerContract.
func (lc *LoggerContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LoggerContract struct.
LoggerContractProperties the Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.
type LoggerContractProperties struct {
// LoggerType - Logger type. Possible values include: 'AzureEventHub', 'ApplicationInsights'
LoggerType LoggerType `json:"loggerType,omitempty"`
// Description - Logger description.
Description *string `json:"description,omitempty"`
// Credentials - The name and SendRule connection string of the event hub for azureEventHub logger.
// Instrumentation key for applicationInsights logger.
Credentials map[string]*string `json:"credentials"`
// IsBuffered - Whether records are buffered in the logger before publishing. Default is assumed to be true.
IsBuffered *bool `json:"isBuffered,omitempty"`
}
func (lcp LoggerContractProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LoggerContractProperties.
LoggerType enumerates the values for logger type.
type LoggerType string
const (
// ApplicationInsights Azure Application Insights as log destination.
ApplicationInsights LoggerType = "applicationInsights"
// AzureEventHub Azure Event Hub as log destination.
AzureEventHub LoggerType = "azureEventHub"
)
func PossibleLoggerTypeValues() []LoggerType
PossibleLoggerTypeValues returns an array of possible values for the LoggerType const type.
LoggerUpdateContract logger update contract.
type LoggerUpdateContract struct {
// LoggerUpdateParameters - Logger entity update contract properties.
*LoggerUpdateParameters `json:"properties,omitempty"`
}
func (luc LoggerUpdateContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LoggerUpdateContract.
func (luc *LoggerUpdateContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for LoggerUpdateContract struct.
LoggerUpdateParameters parameters supplied to the Update Logger operation.
type LoggerUpdateParameters struct {
// LoggerType - Logger type. Possible values include: 'AzureEventHub', 'ApplicationInsights'
LoggerType LoggerType `json:"loggerType,omitempty"`
// Description - Logger description.
Description *string `json:"description,omitempty"`
// Credentials - Logger credentials.
Credentials map[string]*string `json:"credentials"`
// IsBuffered - Whether records are buffered in the logger before publishing. Default is assumed to be true.
IsBuffered *bool `json:"isBuffered,omitempty"`
}
func (lup LoggerUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LoggerUpdateParameters.
NameAvailabilityReason enumerates the values for name availability reason.
type NameAvailabilityReason string
const (
// AlreadyExists ...
AlreadyExists NameAvailabilityReason = "AlreadyExists"
// Invalid ...
Invalid NameAvailabilityReason = "Invalid"
// Valid ...
Valid NameAvailabilityReason = "Valid"
)
func PossibleNameAvailabilityReasonValues() []NameAvailabilityReason
PossibleNameAvailabilityReasonValues returns an array of possible values for the NameAvailabilityReason const type.
NetworkStatusClient is the apiManagement Client
type NetworkStatusClient struct {
BaseClient
}
func NewNetworkStatusClient(subscriptionID string) NetworkStatusClient
NewNetworkStatusClient creates an instance of the NetworkStatusClient client.
func NewNetworkStatusClientWithBaseURI(baseURI string, subscriptionID string) NetworkStatusClient
NewNetworkStatusClientWithBaseURI creates an instance of the NetworkStatusClient 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 (client NetworkStatusClient) ListByLocation(ctx context.Context, resourceGroupName string, serviceName string, locationName string) (result NetworkStatusContract, err error)
ListByLocation gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. locationName - location in which the API Management service is deployed. This is one of the Azure Regions like West US, East US, South Central US.
func (client NetworkStatusClient) ListByLocationPreparer(ctx context.Context, resourceGroupName string, serviceName string, locationName string) (*http.Request, error)
ListByLocationPreparer prepares the ListByLocation request.
func (client NetworkStatusClient) ListByLocationResponder(resp *http.Response) (result NetworkStatusContract, err error)
ListByLocationResponder handles the response to the ListByLocation request. The method always closes the http.Response Body.
func (client NetworkStatusClient) ListByLocationSender(req *http.Request) (*http.Response, error)
ListByLocationSender sends the ListByLocation request. The method will close the http.Response Body if it receives an error.
func (client NetworkStatusClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string) (result ListNetworkStatusContractByLocation, err error)
ListByService gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client NetworkStatusClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client NetworkStatusClient) ListByServiceResponder(resp *http.Response) (result ListNetworkStatusContractByLocation, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client NetworkStatusClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
NetworkStatusContract network Status details.
type NetworkStatusContract struct {
autorest.Response `json:"-"`
// DNSServers - Gets the list of DNS servers IPV4 addresses.
DNSServers *[]string `json:"dnsServers,omitempty"`
// ConnectivityStatus - Gets the list of Connectivity Status to the Resources on which the service depends upon.
ConnectivityStatus *[]ConnectivityStatusContract `json:"connectivityStatus,omitempty"`
}
NetworkStatusContractByLocation network Status in the Location
type NetworkStatusContractByLocation struct {
// Location - Location of service
Location *string `json:"location,omitempty"`
// NetworkStatus - Network status in Location
NetworkStatus *NetworkStatusContract `json:"networkStatus,omitempty"`
}
NotificationClient is the apiManagement Client
type NotificationClient struct {
BaseClient
}
func NewNotificationClient(subscriptionID string) NotificationClient
NewNotificationClient creates an instance of the NotificationClient client.
func NewNotificationClientWithBaseURI(baseURI string, subscriptionID string) NotificationClient
NewNotificationClientWithBaseURI creates an instance of the NotificationClient 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 (client NotificationClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, ifMatch string) (result NotificationContract, err error)
CreateOrUpdate updates an Notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client NotificationClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client NotificationClient) CreateOrUpdateResponder(resp *http.Response) (result NotificationContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client NotificationClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client NotificationClient) Get(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName) (result NotificationContract, err error)
Get gets the details of the Notification specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier.
func (client NotificationClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName) (*http.Request, error)
GetPreparer prepares the Get request.
func (client NotificationClient) GetResponder(resp *http.Response) (result NotificationContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client NotificationClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client NotificationClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, top *int32, skip *int32) (result NotificationCollectionPage, err error)
ListByService lists a collection of properties defined within a service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. top - number of records to return. skip - number of records to skip.
func (client NotificationClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, top *int32, skip *int32) (result NotificationCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client NotificationClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client NotificationClient) ListByServiceResponder(resp *http.Response) (result NotificationCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client NotificationClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
NotificationCollection paged Notification list representation.
type NotificationCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]NotificationContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (nc NotificationCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
NotificationCollectionIterator provides access to a complete listing of NotificationContract values.
type NotificationCollectionIterator struct {
// contains filtered or unexported fields
}
func NewNotificationCollectionIterator(page NotificationCollectionPage) NotificationCollectionIterator
Creates a new instance of the NotificationCollectionIterator type.
func (iter *NotificationCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *NotificationCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter NotificationCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter NotificationCollectionIterator) Response() NotificationCollection
Response returns the raw server response from the last page request.
func (iter NotificationCollectionIterator) Value() NotificationContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
NotificationCollectionPage contains a page of NotificationContract values.
type NotificationCollectionPage struct {
// contains filtered or unexported fields
}
func NewNotificationCollectionPage(cur NotificationCollection, getNextPage func(context.Context, NotificationCollection) (NotificationCollection, error)) NotificationCollectionPage
Creates a new instance of the NotificationCollectionPage type.
func (page *NotificationCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *NotificationCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page NotificationCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page NotificationCollectionPage) Response() NotificationCollection
Response returns the raw server response from the last page request.
func (page NotificationCollectionPage) Values() []NotificationContract
Values returns the slice of values for the current page or nil if there are no values.
NotificationContract notification details.
type NotificationContract struct {
autorest.Response `json:"-"`
// NotificationContractProperties - Notification entity contract properties.
*NotificationContractProperties `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"`
}
func (nc NotificationContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NotificationContract.
func (nc *NotificationContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for NotificationContract struct.
NotificationContractProperties notification Contract properties.
type NotificationContractProperties struct {
// Title - Title of the Notification.
Title *string `json:"title,omitempty"`
// Description - Description of the Notification.
Description *string `json:"description,omitempty"`
// Recipients - Recipient Parameter values.
Recipients *RecipientsContractProperties `json:"recipients,omitempty"`
}
NotificationName enumerates the values for notification name.
type NotificationName string
const (
// AccountClosedPublisher The following email recipients and users will receive email notifications when
// developer closes his account.
AccountClosedPublisher NotificationName = "AccountClosedPublisher"
// BCC The following recipients will receive blind carbon copies of all emails sent to developers.
BCC NotificationName = "BCC"
// NewApplicationNotificationMessage The following email recipients and users will receive email
// notifications when new applications are submitted to the application gallery.
NewApplicationNotificationMessage NotificationName = "NewApplicationNotificationMessage"
// NewIssuePublisherNotificationMessage The following email recipients and users will receive email
// notifications when a new issue or comment is submitted on the developer portal.
NewIssuePublisherNotificationMessage NotificationName = "NewIssuePublisherNotificationMessage"
// PurchasePublisherNotificationMessage The following email recipients and users will receive email
// notifications about new API product subscriptions.
PurchasePublisherNotificationMessage NotificationName = "PurchasePublisherNotificationMessage"
// QuotaLimitApproachingPublisherNotificationMessage The following email recipients and users will receive
// email notifications when subscription usage gets close to usage quota.
QuotaLimitApproachingPublisherNotificationMessage NotificationName = "QuotaLimitApproachingPublisherNotificationMessage"
// RequestPublisherNotificationMessage The following email recipients and users will receive email
// notifications about subscription requests for API products requiring approval.
RequestPublisherNotificationMessage NotificationName = "RequestPublisherNotificationMessage"
)
func PossibleNotificationNameValues() []NotificationName
PossibleNotificationNameValues returns an array of possible values for the NotificationName const type.
NotificationRecipientEmailClient is the apiManagement Client
type NotificationRecipientEmailClient struct {
BaseClient
}
func NewNotificationRecipientEmailClient(subscriptionID string) NotificationRecipientEmailClient
NewNotificationRecipientEmailClient creates an instance of the NotificationRecipientEmailClient client.
func NewNotificationRecipientEmailClientWithBaseURI(baseURI string, subscriptionID string) NotificationRecipientEmailClient
NewNotificationRecipientEmailClientWithBaseURI creates an instance of the NotificationRecipientEmailClient 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 (client NotificationRecipientEmailClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, email string) (result autorest.Response, err error)
CheckEntityExists determine if Notification Recipient Email subscribed to the notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier. email - email identifier.
func (client NotificationRecipientEmailClient) CheckEntityExistsPreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, email string) (*http.Request, error)
CheckEntityExistsPreparer prepares the CheckEntityExists request.
func (client NotificationRecipientEmailClient) CheckEntityExistsResponder(resp *http.Response) (result autorest.Response, err error)
CheckEntityExistsResponder handles the response to the CheckEntityExists request. The method always closes the http.Response Body.
func (client NotificationRecipientEmailClient) CheckEntityExistsSender(req *http.Request) (*http.Response, error)
CheckEntityExistsSender sends the CheckEntityExists request. The method will close the http.Response Body if it receives an error.
func (client NotificationRecipientEmailClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, email string) (result RecipientEmailContract, err error)
CreateOrUpdate adds the Email address to the list of Recipients for the Notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier. email - email identifier.
func (client NotificationRecipientEmailClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, email string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client NotificationRecipientEmailClient) CreateOrUpdateResponder(resp *http.Response) (result RecipientEmailContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client NotificationRecipientEmailClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client NotificationRecipientEmailClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, email string) (result autorest.Response, err error)
Delete removes the email from the list of Notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier. email - email identifier.
func (client NotificationRecipientEmailClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, email string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client NotificationRecipientEmailClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client NotificationRecipientEmailClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client NotificationRecipientEmailClient) ListByNotification(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName) (result RecipientEmailCollection, err error)
ListByNotification gets the list of the Notification Recipient Emails subscribed to a notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier.
func (client NotificationRecipientEmailClient) ListByNotificationPreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName) (*http.Request, error)
ListByNotificationPreparer prepares the ListByNotification request.
func (client NotificationRecipientEmailClient) ListByNotificationResponder(resp *http.Response) (result RecipientEmailCollection, err error)
ListByNotificationResponder handles the response to the ListByNotification request. The method always closes the http.Response Body.
func (client NotificationRecipientEmailClient) ListByNotificationSender(req *http.Request) (*http.Response, error)
ListByNotificationSender sends the ListByNotification request. The method will close the http.Response Body if it receives an error.
NotificationRecipientUserClient is the apiManagement Client
type NotificationRecipientUserClient struct {
BaseClient
}
func NewNotificationRecipientUserClient(subscriptionID string) NotificationRecipientUserClient
NewNotificationRecipientUserClient creates an instance of the NotificationRecipientUserClient client.
func NewNotificationRecipientUserClientWithBaseURI(baseURI string, subscriptionID string) NotificationRecipientUserClient
NewNotificationRecipientUserClientWithBaseURI creates an instance of the NotificationRecipientUserClient 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 (client NotificationRecipientUserClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, UID string) (result autorest.Response, err error)
CheckEntityExists determine if the Notification Recipient User is subscribed to the notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier. UID - user identifier. Must be unique in the current API Management service instance.
func (client NotificationRecipientUserClient) CheckEntityExistsPreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, UID string) (*http.Request, error)
CheckEntityExistsPreparer prepares the CheckEntityExists request.
func (client NotificationRecipientUserClient) CheckEntityExistsResponder(resp *http.Response) (result autorest.Response, err error)
CheckEntityExistsResponder handles the response to the CheckEntityExists request. The method always closes the http.Response Body.
func (client NotificationRecipientUserClient) CheckEntityExistsSender(req *http.Request) (*http.Response, error)
CheckEntityExistsSender sends the CheckEntityExists request. The method will close the http.Response Body if it receives an error.
func (client NotificationRecipientUserClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, UID string) (result RecipientUserContract, err error)
CreateOrUpdate adds the API Management User to the list of Recipients for the Notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier. UID - user identifier. Must be unique in the current API Management service instance.
func (client NotificationRecipientUserClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, UID string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client NotificationRecipientUserClient) CreateOrUpdateResponder(resp *http.Response) (result RecipientUserContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client NotificationRecipientUserClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client NotificationRecipientUserClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, UID string) (result autorest.Response, err error)
Delete removes the API Management user from the list of Notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier. UID - user identifier. Must be unique in the current API Management service instance.
func (client NotificationRecipientUserClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName, UID string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client NotificationRecipientUserClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client NotificationRecipientUserClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client NotificationRecipientUserClient) ListByNotification(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName) (result RecipientUserCollection, err error)
ListByNotification gets the list of the Notification Recipient User subscribed to the notification. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. notificationName - notification Name Identifier.
func (client NotificationRecipientUserClient) ListByNotificationPreparer(ctx context.Context, resourceGroupName string, serviceName string, notificationName NotificationName) (*http.Request, error)
ListByNotificationPreparer prepares the ListByNotification request.
func (client NotificationRecipientUserClient) ListByNotificationResponder(resp *http.Response) (result RecipientUserCollection, err error)
ListByNotificationResponder handles the response to the ListByNotification request. The method always closes the http.Response Body.
func (client NotificationRecipientUserClient) ListByNotificationSender(req *http.Request) (*http.Response, error)
ListByNotificationSender sends the ListByNotification request. The method will close the http.Response Body if it receives an error.
OAuth2AuthenticationSettingsContract API OAuth2 Authentication settings details.
type OAuth2AuthenticationSettingsContract struct {
// AuthorizationServerID - OAuth authorization server identifier.
AuthorizationServerID *string `json:"authorizationServerId,omitempty"`
// Scope - operations scope.
Scope *string `json:"scope,omitempty"`
}
OpenIDAuthenticationSettingsContract API OAuth2 Authentication settings details.
type OpenIDAuthenticationSettingsContract struct {
// OpenidProviderID - OAuth authorization server identifier.
OpenidProviderID *string `json:"openidProviderId,omitempty"`
// BearerTokenSendingMethods - How to send token to the server.
BearerTokenSendingMethods *[]BearerTokenSendingMethods `json:"bearerTokenSendingMethods,omitempty"`
}
OpenIDConnectProviderClient is the apiManagement Client
type OpenIDConnectProviderClient struct {
BaseClient
}
func NewOpenIDConnectProviderClient(subscriptionID string) OpenIDConnectProviderClient
NewOpenIDConnectProviderClient creates an instance of the OpenIDConnectProviderClient client.
func NewOpenIDConnectProviderClientWithBaseURI(baseURI string, subscriptionID string) OpenIDConnectProviderClient
NewOpenIDConnectProviderClientWithBaseURI creates an instance of the OpenIDConnectProviderClient 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 (client OpenIDConnectProviderClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, opid string, parameters OpenidConnectProviderContract, ifMatch string) (result OpenidConnectProviderContract, err error)
CreateOrUpdate creates or updates the OpenID Connect Provider. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. opid - identifier of the OpenID Connect Provider. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client OpenIDConnectProviderClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, opid string, parameters OpenidConnectProviderContract, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client OpenIDConnectProviderClient) CreateOrUpdateResponder(resp *http.Response) (result OpenidConnectProviderContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client OpenIDConnectProviderClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client OpenIDConnectProviderClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, opid string, ifMatch string) (result autorest.Response, err error)
Delete deletes specific OpenID Connect Provider of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. opid - identifier of the OpenID Connect Provider. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client OpenIDConnectProviderClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, opid string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client OpenIDConnectProviderClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client OpenIDConnectProviderClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client OpenIDConnectProviderClient) Get(ctx context.Context, resourceGroupName string, serviceName string, opid string) (result OpenidConnectProviderContract, err error)
Get gets specific OpenID Connect Provider. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. opid - identifier of the OpenID Connect Provider.
func (client OpenIDConnectProviderClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, opid string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. opid - identifier of the OpenID Connect Provider.
func (client OpenIDConnectProviderClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, opid string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client OpenIDConnectProviderClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client OpenIDConnectProviderClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client OpenIDConnectProviderClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, opid string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client OpenIDConnectProviderClient) GetResponder(resp *http.Response) (result OpenidConnectProviderContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client OpenIDConnectProviderClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client OpenIDConnectProviderClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result OpenIDConnectProviderCollectionPage, err error)
ListByService lists all OpenID Connect Providers. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client OpenIDConnectProviderClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result OpenIDConnectProviderCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client OpenIDConnectProviderClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client OpenIDConnectProviderClient) ListByServiceResponder(resp *http.Response) (result OpenIDConnectProviderCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client OpenIDConnectProviderClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
func (client OpenIDConnectProviderClient) Update(ctx context.Context, resourceGroupName string, serviceName string, opid string, parameters OpenidConnectProviderUpdateContract, ifMatch string) (result autorest.Response, err error)
Update updates the specific OpenID Connect Provider. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. opid - identifier of the OpenID Connect Provider. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client OpenIDConnectProviderClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, opid string, parameters OpenidConnectProviderUpdateContract, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client OpenIDConnectProviderClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client OpenIDConnectProviderClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
OpenIDConnectProviderCollection paged OpenIdProviders list representation.
type OpenIDConnectProviderCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]OpenidConnectProviderContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (oicpc OpenIDConnectProviderCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
OpenIDConnectProviderCollectionIterator provides access to a complete listing of OpenidConnectProviderContract values.
type OpenIDConnectProviderCollectionIterator struct {
// contains filtered or unexported fields
}
func NewOpenIDConnectProviderCollectionIterator(page OpenIDConnectProviderCollectionPage) OpenIDConnectProviderCollectionIterator
Creates a new instance of the OpenIDConnectProviderCollectionIterator type.
func (iter *OpenIDConnectProviderCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *OpenIDConnectProviderCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter OpenIDConnectProviderCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OpenIDConnectProviderCollectionIterator) Response() OpenIDConnectProviderCollection
Response returns the raw server response from the last page request.
func (iter OpenIDConnectProviderCollectionIterator) Value() OpenidConnectProviderContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
OpenIDConnectProviderCollectionPage contains a page of OpenidConnectProviderContract values.
type OpenIDConnectProviderCollectionPage struct {
// contains filtered or unexported fields
}
func NewOpenIDConnectProviderCollectionPage(cur OpenIDConnectProviderCollection, getNextPage func(context.Context, OpenIDConnectProviderCollection) (OpenIDConnectProviderCollection, error)) OpenIDConnectProviderCollectionPage
Creates a new instance of the OpenIDConnectProviderCollectionPage type.
func (page *OpenIDConnectProviderCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *OpenIDConnectProviderCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page OpenIDConnectProviderCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OpenIDConnectProviderCollectionPage) Response() OpenIDConnectProviderCollection
Response returns the raw server response from the last page request.
func (page OpenIDConnectProviderCollectionPage) Values() []OpenidConnectProviderContract
Values returns the slice of values for the current page or nil if there are no values.
OpenidConnectProviderContract openId Connect Provider details.
type OpenidConnectProviderContract struct {
autorest.Response `json:"-"`
// OpenidConnectProviderContractProperties - OpenId Connect Provider contract properties.
*OpenidConnectProviderContractProperties `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"`
}
func (ocpc OpenidConnectProviderContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OpenidConnectProviderContract.
func (ocpc *OpenidConnectProviderContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for OpenidConnectProviderContract struct.
OpenidConnectProviderContractProperties openID Connect Providers Contract.
type OpenidConnectProviderContractProperties struct {
// DisplayName - User-friendly OpenID Connect Provider name.
DisplayName *string `json:"displayName,omitempty"`
// Description - User-friendly description of OpenID Connect Provider.
Description *string `json:"description,omitempty"`
// MetadataEndpoint - Metadata endpoint URI.
MetadataEndpoint *string `json:"metadataEndpoint,omitempty"`
// ClientID - Client ID of developer console which is the client application.
ClientID *string `json:"clientId,omitempty"`
// ClientSecret - Client Secret of developer console which is the client application.
ClientSecret *string `json:"clientSecret,omitempty"`
}
OpenidConnectProviderUpdateContract parameters supplied to the Update OpenID Connect Provider operation.
type OpenidConnectProviderUpdateContract struct {
// OpenidConnectProviderUpdateContractProperties - OpenId Connect Provider Update contract properties.
*OpenidConnectProviderUpdateContractProperties `json:"properties,omitempty"`
}
func (ocpuc OpenidConnectProviderUpdateContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OpenidConnectProviderUpdateContract.
func (ocpuc *OpenidConnectProviderUpdateContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for OpenidConnectProviderUpdateContract struct.
OpenidConnectProviderUpdateContractProperties parameters supplied to the Update OpenID Connect Provider operation.
type OpenidConnectProviderUpdateContractProperties struct {
// DisplayName - User-friendly OpenID Connect Provider name.
DisplayName *string `json:"displayName,omitempty"`
// Description - User-friendly description of OpenID Connect Provider.
Description *string `json:"description,omitempty"`
// MetadataEndpoint - Metadata endpoint URI.
MetadataEndpoint *string `json:"metadataEndpoint,omitempty"`
// ClientID - Client ID of developer console which is the client application.
ClientID *string `json:"clientId,omitempty"`
// ClientSecret - Client Secret of developer console which is the client application.
ClientSecret *string `json:"clientSecret,omitempty"`
}
Operation REST API operation
type Operation struct {
// Name - Operation name: {provider}/{resource}/{operation}
Name *string `json:"name,omitempty"`
// Display - The object that describes the operation.
Display *OperationDisplay `json:"display,omitempty"`
// Origin - The operation origin.
Origin *string `json:"origin,omitempty"`
// Properties - The operation properties.
Properties interface{} `json:"properties,omitempty"`
}
OperationClient is the apiManagement Client
type OperationClient struct {
BaseClient
}
func NewOperationClient(subscriptionID string) OperationClient
NewOperationClient creates an instance of the OperationClient client.
func NewOperationClientWithBaseURI(baseURI string, subscriptionID string) OperationClient
NewOperationClientWithBaseURI creates an instance of the OperationClient 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 (client OperationClient) ListByTags(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result TagResourceCollectionPage, err error)
ListByTags lists a collection of operations associated with tags. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client OperationClient) ListByTagsComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result TagResourceCollectionIterator, err error)
ListByTagsComplete enumerates all values, automatically crossing page boundaries as required.
func (client OperationClient) ListByTagsPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByTagsPreparer prepares the ListByTags request.
func (client OperationClient) ListByTagsResponder(resp *http.Response) (result TagResourceCollection, err error)
ListByTagsResponder handles the response to the ListByTags request. The method always closes the http.Response Body.
func (client OperationClient) ListByTagsSender(req *http.Request) (*http.Response, error)
ListByTagsSender sends the ListByTags request. The method will close the http.Response Body if it receives an error.
OperationCollection paged Operation list representation.
type OperationCollection struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; Page values.
Value *[]OperationContract `json:"value,omitempty"`
// NextLink - READ-ONLY; Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (oc OperationCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (oc OperationCollection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationCollection.
OperationCollectionIterator provides access to a complete listing of OperationContract values.
type OperationCollectionIterator struct {
// contains filtered or unexported fields
}
func NewOperationCollectionIterator(page OperationCollectionPage) OperationCollectionIterator
Creates a new instance of the OperationCollectionIterator type.
func (iter *OperationCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *OperationCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter OperationCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationCollectionIterator) Response() OperationCollection
Response returns the raw server response from the last page request.
func (iter OperationCollectionIterator) Value() OperationContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
OperationCollectionPage contains a page of OperationContract values.
type OperationCollectionPage struct {
// contains filtered or unexported fields
}
func NewOperationCollectionPage(cur OperationCollection, getNextPage func(context.Context, OperationCollection) (OperationCollection, error)) OperationCollectionPage
Creates a new instance of the OperationCollectionPage type.
func (page *OperationCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *OperationCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page OperationCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationCollectionPage) Response() OperationCollection
Response returns the raw server response from the last page request.
func (page OperationCollectionPage) Values() []OperationContract
Values returns the slice of values for the current page or nil if there are no values.
OperationContract api Operation details.
type OperationContract struct {
autorest.Response `json:"-"`
// OperationContractProperties - Properties of the Operation Contract.
*OperationContractProperties `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"`
}
func (oc OperationContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationContract.
func (oc *OperationContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for OperationContract struct.
OperationContractProperties operation Contract Properties
type OperationContractProperties struct {
// DisplayName - Operation Name.
DisplayName *string `json:"displayName,omitempty"`
// Method - A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
Method *string `json:"method,omitempty"`
// URLTemplate - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
URLTemplate *string `json:"urlTemplate,omitempty"`
// TemplateParameters - Collection of URL template parameters.
TemplateParameters *[]ParameterContract `json:"templateParameters,omitempty"`
// Description - Description of the operation. May include HTML formatting tags.
Description *string `json:"description,omitempty"`
// Request - An entity containing request details.
Request *RequestContract `json:"request,omitempty"`
// Responses - Array of Operation responses.
Responses *[]ResponseContract `json:"responses,omitempty"`
// Policies - Operation Policies
Policies *string `json:"policies,omitempty"`
}
OperationDisplay the object that describes the operation.
type OperationDisplay struct {
// Provider - Friendly name of the resource provider
Provider *string `json:"provider,omitempty"`
// Operation - Operation type: read, write, delete, listKeys/action, etc.
Operation *string `json:"operation,omitempty"`
// Resource - Resource type on which the operation is performed.
Resource *string `json:"resource,omitempty"`
// Description - Friendly name of the operation
Description *string `json:"description,omitempty"`
}
OperationEntityBaseContract api Operation Entity Base Contract details.
type OperationEntityBaseContract struct {
// TemplateParameters - Collection of URL template parameters.
TemplateParameters *[]ParameterContract `json:"templateParameters,omitempty"`
// Description - Description of the operation. May include HTML formatting tags.
Description *string `json:"description,omitempty"`
// Request - An entity containing request details.
Request *RequestContract `json:"request,omitempty"`
// Responses - Array of Operation responses.
Responses *[]ResponseContract `json:"responses,omitempty"`
// Policies - Operation Policies
Policies *string `json:"policies,omitempty"`
}
OperationListResult result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.
type OperationListResult struct {
autorest.Response `json:"-"`
// Value - List of operations supported by the resource provider.
Value *[]Operation `json:"value,omitempty"`
// NextLink - URL to get the next set of operation list results if there are any.
NextLink *string `json:"nextLink,omitempty"`
}
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
OperationListResultIterator provides access to a complete listing of Operation values.
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
func (iter *OperationListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (iter OperationListResultIterator) Value() Operation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
OperationListResultPage contains a page of Operation values.
type OperationListResultPage struct {
// contains filtered or unexported fields
}
func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
func (page *OperationListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (page OperationListResultPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
OperationResultContract operation Result.
type OperationResultContract struct {
autorest.Response `json:"-"`
// ID - Operation result identifier.
ID *string `json:"id,omitempty"`
// Status - Status of an async operation. Possible values include: 'Started', 'InProgress', 'Succeeded', 'Failed'
Status AsyncOperationStatus `json:"status,omitempty"`
// Started - Start time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
Started *date.Time `json:"started,omitempty"`
// Updated - Last update time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
Updated *date.Time `json:"updated,omitempty"`
// ResultInfo - Optional result info.
ResultInfo *string `json:"resultInfo,omitempty"`
// Error - Error Body Contract
Error *ErrorResponseBody `json:"error,omitempty"`
// ActionLog - READ-ONLY; This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation.
ActionLog *[]OperationResultLogItemContract `json:"actionLog,omitempty"`
}
func (orc OperationResultContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationResultContract.
OperationResultLogItemContract log of the entity being created, updated or deleted.
type OperationResultLogItemContract struct {
// ObjectType - The type of entity contract.
ObjectType *string `json:"objectType,omitempty"`
// Action - Action like create/update/delete.
Action *string `json:"action,omitempty"`
// ObjectKey - Identifier of the entity being created/updated/deleted.
ObjectKey *string `json:"objectKey,omitempty"`
}
OperationTagResourceContractProperties operation Entity contract Properties.
type OperationTagResourceContractProperties struct {
// ID - Identifier of the operation in form /operations/{operationId}.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; Operation name.
Name *string `json:"name,omitempty"`
// APIName - READ-ONLY; Api Name.
APIName *string `json:"apiName,omitempty"`
// APIRevision - READ-ONLY; Api Revision.
APIRevision *string `json:"apiRevision,omitempty"`
// APIVersion - READ-ONLY; Api Version.
APIVersion *string `json:"apiVersion,omitempty"`
// Description - READ-ONLY; Operation Description.
Description *string `json:"description,omitempty"`
// Method - READ-ONLY; A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
Method *string `json:"method,omitempty"`
// URLTemplate - READ-ONLY; Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
URLTemplate *string `json:"urlTemplate,omitempty"`
}
func (otrcp OperationTagResourceContractProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationTagResourceContractProperties.
OperationUpdateContract api Operation Update Contract details.
type OperationUpdateContract struct {
// OperationUpdateContractProperties - Properties of the API Operation entity that can be updated.
*OperationUpdateContractProperties `json:"properties,omitempty"`
}
func (ouc OperationUpdateContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationUpdateContract.
func (ouc *OperationUpdateContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for OperationUpdateContract struct.
OperationUpdateContractProperties operation Update Contract Properties.
type OperationUpdateContractProperties struct {
// DisplayName - Operation Name.
DisplayName *string `json:"displayName,omitempty"`
// Method - A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
Method *string `json:"method,omitempty"`
// URLTemplate - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
URLTemplate *string `json:"urlTemplate,omitempty"`
// TemplateParameters - Collection of URL template parameters.
TemplateParameters *[]ParameterContract `json:"templateParameters,omitempty"`
// Description - Description of the operation. May include HTML formatting tags.
Description *string `json:"description,omitempty"`
// Request - An entity containing request details.
Request *RequestContract `json:"request,omitempty"`
// Responses - Array of Operation responses.
Responses *[]ResponseContract `json:"responses,omitempty"`
// Policies - Operation Policies
Policies *string `json:"policies,omitempty"`
}
OperationsClient is the apiManagement Client
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient 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 (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists all of the available REST API operations of the Microsoft.ApiManagement provider.
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
ParameterContract operation parameters details.
type ParameterContract struct {
// Name - Parameter name.
Name *string `json:"name,omitempty"`
// Description - Parameter description.
Description *string `json:"description,omitempty"`
// Type - Parameter type.
Type *string `json:"type,omitempty"`
// DefaultValue - Default parameter value.
DefaultValue *string `json:"defaultValue,omitempty"`
// Required - whether parameter is required or not.
Required *bool `json:"required,omitempty"`
// Values - Parameter values.
Values *[]string `json:"values,omitempty"`
}
PolicyClient is the apiManagement Client
type PolicyClient struct {
BaseClient
}
func NewPolicyClient(subscriptionID string) PolicyClient
NewPolicyClient creates an instance of the PolicyClient client.
func NewPolicyClientWithBaseURI(baseURI string, subscriptionID string) PolicyClient
NewPolicyClientWithBaseURI creates an instance of the PolicyClient 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 (client PolicyClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters PolicyContract) (result PolicyContract, err error)
CreateOrUpdate creates or updates the global policy configuration of the Api Management service. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - the policy contents to apply.
func (client PolicyClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters PolicyContract) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client PolicyClient) CreateOrUpdateResponder(resp *http.Response) (result PolicyContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client PolicyClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client PolicyClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, ifMatch string) (result autorest.Response, err error)
Delete deletes the global policy configuration of the Api Management Service. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client PolicyClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client PolicyClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client PolicyClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client PolicyClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result PolicyContract, err error)
Get get the Global policy definition of the Api Management service. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client PolicyClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the Global policy definition in the Api Management service. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client PolicyClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client PolicyClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client PolicyClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client PolicyClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client PolicyClient) GetResponder(resp *http.Response) (result PolicyContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client PolicyClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client PolicyClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, scope PolicyScopeContract) (result PolicyCollection, err error)
ListByService lists all the Global Policy definitions of the Api Management service. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. scope - policy scope.
func (client PolicyClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, scope PolicyScopeContract) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client PolicyClient) ListByServiceResponder(resp *http.Response) (result PolicyCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client PolicyClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
PolicyCollection the response of the list policy operation.
type PolicyCollection struct {
autorest.Response `json:"-"`
// Value - Policy Contract value.
Value *[]PolicyContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
PolicyContentFormat enumerates the values for policy content format.
type PolicyContentFormat string
const (
// Rawxml The contents are inline and Content type is a non XML encoded policy document.
Rawxml PolicyContentFormat = "rawxml"
// RawxmlLink The policy document is not Xml encoded and is hosted on a http endpoint accessible from the
// API Management service.
RawxmlLink PolicyContentFormat = "rawxml-link"
// XML The contents are inline and Content type is an XML document.
XML PolicyContentFormat = "xml"
// XMLLink The policy XML document is hosted on a http endpoint accessible from the API Management service.
XMLLink PolicyContentFormat = "xml-link"
)
func PossiblePolicyContentFormatValues() []PolicyContentFormat
PossiblePolicyContentFormatValues returns an array of possible values for the PolicyContentFormat const type.
PolicyContract policy Contract details.
type PolicyContract struct {
autorest.Response `json:"-"`
// PolicyContractProperties - Properties of the Policy.
*PolicyContractProperties `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"`
}
func (pc PolicyContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PolicyContract.
func (pc *PolicyContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PolicyContract struct.
PolicyContractProperties policy contract Properties.
type PolicyContractProperties struct {
// PolicyContent - Json escaped Xml Encoded contents of the Policy.
PolicyContent *string `json:"policyContent,omitempty"`
// ContentFormat - Format of the policyContent. Possible values include: 'XML', 'XMLLink', 'Rawxml', 'RawxmlLink'
ContentFormat PolicyContentFormat `json:"contentFormat,omitempty"`
}
PolicyScopeContract enumerates the values for policy scope contract.
type PolicyScopeContract string
const (
// PolicyScopeContractAll ...
PolicyScopeContractAll PolicyScopeContract = "All"
// PolicyScopeContractAPI ...
PolicyScopeContractAPI PolicyScopeContract = "Api"
// PolicyScopeContractOperation ...
PolicyScopeContractOperation PolicyScopeContract = "Operation"
// PolicyScopeContractProduct ...
PolicyScopeContractProduct PolicyScopeContract = "Product"
// PolicyScopeContractTenant ...
PolicyScopeContractTenant PolicyScopeContract = "Tenant"
)
func PossiblePolicyScopeContractValues() []PolicyScopeContract
PossiblePolicyScopeContractValues returns an array of possible values for the PolicyScopeContract const type.
PolicySnippetContract policy snippet.
type PolicySnippetContract struct {
// Name - READ-ONLY; Snippet name.
Name *string `json:"name,omitempty"`
// Content - READ-ONLY; Snippet content.
Content *string `json:"content,omitempty"`
// ToolTip - READ-ONLY; Snippet toolTip.
ToolTip *string `json:"toolTip,omitempty"`
// Scope - READ-ONLY; Binary OR value of the Snippet scope.
Scope *int32 `json:"scope,omitempty"`
}
func (psc PolicySnippetContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PolicySnippetContract.
PolicySnippetsClient is the apiManagement Client
type PolicySnippetsClient struct {
BaseClient
}
func NewPolicySnippetsClient(subscriptionID string) PolicySnippetsClient
NewPolicySnippetsClient creates an instance of the PolicySnippetsClient client.
func NewPolicySnippetsClientWithBaseURI(baseURI string, subscriptionID string) PolicySnippetsClient
NewPolicySnippetsClientWithBaseURI creates an instance of the PolicySnippetsClient 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 (client PolicySnippetsClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, scope PolicyScopeContract) (result PolicySnippetsCollection, err error)
ListByService lists all policy snippets. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. scope - policy scope.
func (client PolicySnippetsClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, scope PolicyScopeContract) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client PolicySnippetsClient) ListByServiceResponder(resp *http.Response) (result PolicySnippetsCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client PolicySnippetsClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
PolicySnippetsCollection the response of the list policy snippets operation.
type PolicySnippetsCollection struct {
autorest.Response `json:"-"`
// Value - Policy snippet value.
Value *[]PolicySnippetContract `json:"value,omitempty"`
}
PortalDelegationSettings delegation settings for a developer portal.
type PortalDelegationSettings struct {
autorest.Response `json:"-"`
// PortalDelegationSettingsProperties - Delegation settings contract properties.
*PortalDelegationSettingsProperties `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"`
}
func (pds PortalDelegationSettings) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PortalDelegationSettings.
func (pds *PortalDelegationSettings) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PortalDelegationSettings struct.
PortalDelegationSettingsProperties delegation settings contract properties.
type PortalDelegationSettingsProperties struct {
// URL - A delegation Url.
URL *string `json:"url,omitempty"`
// ValidationKey - A base64-encoded validation key to validate, that a request is coming from Azure API Management.
ValidationKey *string `json:"validationKey,omitempty"`
// Subscriptions - Subscriptions delegation settings.
Subscriptions *SubscriptionsDelegationSettingsProperties `json:"subscriptions,omitempty"`
// UserRegistration - User registration delegation settings.
UserRegistration *RegistrationDelegationSettingsProperties `json:"userRegistration,omitempty"`
}
PortalSigninSettingProperties sign-in settings contract properties.
type PortalSigninSettingProperties struct {
// Enabled - Redirect Anonymous users to the Sign-In page.
Enabled *bool `json:"enabled,omitempty"`
}
PortalSigninSettings sign-In settings for the Developer Portal.
type PortalSigninSettings struct {
autorest.Response `json:"-"`
// PortalSigninSettingProperties - Sign-in settings contract properties.
*PortalSigninSettingProperties `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"`
}
func (pss PortalSigninSettings) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PortalSigninSettings.
func (pss *PortalSigninSettings) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PortalSigninSettings struct.
PortalSignupSettings sign-Up settings for a developer portal.
type PortalSignupSettings struct {
autorest.Response `json:"-"`
// PortalSignupSettingsProperties - Sign-up settings contract properties.
*PortalSignupSettingsProperties `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"`
}
func (pss PortalSignupSettings) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PortalSignupSettings.
func (pss *PortalSignupSettings) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PortalSignupSettings struct.
PortalSignupSettingsProperties sign-up settings contract properties.
type PortalSignupSettingsProperties struct {
// Enabled - Allow users to sign up on a developer portal.
Enabled *bool `json:"enabled,omitempty"`
// TermsOfService - Terms of service contract properties.
TermsOfService *TermsOfServiceProperties `json:"termsOfService,omitempty"`
}
ProductAPIClient is the apiManagement Client
type ProductAPIClient struct {
BaseClient
}
func NewProductAPIClient(subscriptionID string) ProductAPIClient
NewProductAPIClient creates an instance of the ProductAPIClient client.
func NewProductAPIClientWithBaseURI(baseURI string, subscriptionID string) ProductAPIClient
NewProductAPIClientWithBaseURI creates an instance of the ProductAPIClient 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 (client ProductAPIClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (result autorest.Response, err error)
CheckEntityExists checks that API entity specified by identifier is associated with the Product entity. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
func (client ProductAPIClient) CheckEntityExistsPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (*http.Request, error)
CheckEntityExistsPreparer prepares the CheckEntityExists request.
func (client ProductAPIClient) CheckEntityExistsResponder(resp *http.Response) (result autorest.Response, err error)
CheckEntityExistsResponder handles the response to the CheckEntityExists request. The method always closes the http.Response Body.
func (client ProductAPIClient) CheckEntityExistsSender(req *http.Request) (*http.Response, error)
CheckEntityExistsSender sends the CheckEntityExists request. The method will close the http.Response Body if it receives an error.
func (client ProductAPIClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (result APIContract, err error)
CreateOrUpdate adds an API to the specified product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
func (client ProductAPIClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ProductAPIClient) CreateOrUpdateResponder(resp *http.Response) (result APIContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ProductAPIClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ProductAPIClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (result autorest.Response, err error)
Delete deletes the specified API from the specified product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
func (client ProductAPIClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, apiid string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ProductAPIClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client ProductAPIClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ProductAPIClient) ListByProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result APICollectionPage, err error)
ListByProduct lists a collection of the APIs associated with a product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client ProductAPIClient) ListByProductComplete(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result APICollectionIterator, err error)
ListByProductComplete enumerates all values, automatically crossing page boundaries as required.
func (client ProductAPIClient) ListByProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByProductPreparer prepares the ListByProduct request.
func (client ProductAPIClient) ListByProductResponder(resp *http.Response) (result APICollection, err error)
ListByProductResponder handles the response to the ListByProduct request. The method always closes the http.Response Body.
func (client ProductAPIClient) ListByProductSender(req *http.Request) (*http.Response, error)
ListByProductSender sends the ListByProduct request. The method will close the http.Response Body if it receives an error.
ProductClient is the apiManagement Client
type ProductClient struct {
BaseClient
}
func NewProductClient(subscriptionID string) ProductClient
NewProductClient creates an instance of the ProductClient client.
func NewProductClientWithBaseURI(baseURI string, subscriptionID string) ProductClient
NewProductClientWithBaseURI creates an instance of the ProductClient 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 (client ProductClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters ProductContract, ifMatch string) (result ProductContract, err error)
CreateOrUpdate creates or Updates a product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. parameters - create or update parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client ProductClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters ProductContract, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ProductClient) CreateOrUpdateResponder(resp *http.Response) (result ProductContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ProductClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ProductClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, productID string, ifMatch string, deleteSubscriptions *bool) (result autorest.Response, err error)
Delete delete product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. deleteSubscriptions - delete existing subscriptions associated with the product or not.
func (client ProductClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, ifMatch string, deleteSubscriptions *bool) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ProductClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client ProductClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ProductClient) Get(ctx context.Context, resourceGroupName string, serviceName string, productID string) (result ProductContract, err error)
Get gets the details of the product specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance.
func (client ProductClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, productID string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the product specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance.
func (client ProductClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client ProductClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client ProductClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client ProductClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ProductClient) GetResponder(resp *http.Response) (result ProductContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client ProductClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ProductClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32, expandGroups *bool) (result ProductCollectionPage, err error)
ListByService lists a collection of products in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | terms | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | top - number of records to return. skip - number of records to skip. expandGroups - when set to true, the response contains an array of groups that have visibility to the product. The default is false.
func (client ProductClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32, expandGroups *bool) (result ProductCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client ProductClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32, expandGroups *bool) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client ProductClient) ListByServiceResponder(resp *http.Response) (result ProductCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client ProductClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
func (client ProductClient) Update(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters ProductUpdateParameters, ifMatch string) (result autorest.Response, err error)
Update update product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client ProductClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters ProductUpdateParameters, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client ProductClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client ProductClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
ProductCollection paged Products list representation.
type ProductCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]ProductContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (pc ProductCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ProductCollectionIterator provides access to a complete listing of ProductContract values.
type ProductCollectionIterator struct {
// contains filtered or unexported fields
}
func NewProductCollectionIterator(page ProductCollectionPage) ProductCollectionIterator
Creates a new instance of the ProductCollectionIterator type.
func (iter *ProductCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ProductCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ProductCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ProductCollectionIterator) Response() ProductCollection
Response returns the raw server response from the last page request.
func (iter ProductCollectionIterator) Value() ProductContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ProductCollectionPage contains a page of ProductContract values.
type ProductCollectionPage struct {
// contains filtered or unexported fields
}
func NewProductCollectionPage(cur ProductCollection, getNextPage func(context.Context, ProductCollection) (ProductCollection, error)) ProductCollectionPage
Creates a new instance of the ProductCollectionPage type.
func (page *ProductCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ProductCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ProductCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ProductCollectionPage) Response() ProductCollection
Response returns the raw server response from the last page request.
func (page ProductCollectionPage) Values() []ProductContract
Values returns the slice of values for the current page or nil if there are no values.
ProductContract product details.
type ProductContract struct {
autorest.Response `json:"-"`
// ProductContractProperties - Product entity contract properties.
*ProductContractProperties `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"`
}
func (pc ProductContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProductContract.
func (pc *ProductContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ProductContract struct.
ProductContractProperties product profile.
type ProductContractProperties struct {
// DisplayName - Product name.
DisplayName *string `json:"displayName,omitempty"`
// Description - Product description. May include HTML formatting tags.
Description *string `json:"description,omitempty"`
// Terms - Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
Terms *string `json:"terms,omitempty"`
// SubscriptionRequired - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
SubscriptionRequired *bool `json:"subscriptionRequired,omitempty"`
// ApprovalRequired - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.
ApprovalRequired *bool `json:"approvalRequired,omitempty"`
// SubscriptionsLimit - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.
SubscriptionsLimit *int32 `json:"subscriptionsLimit,omitempty"`
// State - whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Possible values include: 'NotPublished', 'Published'
State ProductState `json:"state,omitempty"`
}
ProductEntityBaseParameters product Entity Base Parameters
type ProductEntityBaseParameters struct {
// Description - Product description. May include HTML formatting tags.
Description *string `json:"description,omitempty"`
// Terms - Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
Terms *string `json:"terms,omitempty"`
// SubscriptionRequired - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
SubscriptionRequired *bool `json:"subscriptionRequired,omitempty"`
// ApprovalRequired - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.
ApprovalRequired *bool `json:"approvalRequired,omitempty"`
// SubscriptionsLimit - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.
SubscriptionsLimit *int32 `json:"subscriptionsLimit,omitempty"`
// State - whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Possible values include: 'NotPublished', 'Published'
State ProductState `json:"state,omitempty"`
}
ProductGroupClient is the apiManagement Client
type ProductGroupClient struct {
BaseClient
}
func NewProductGroupClient(subscriptionID string) ProductGroupClient
NewProductGroupClient creates an instance of the ProductGroupClient client.
func NewProductGroupClientWithBaseURI(baseURI string, subscriptionID string) ProductGroupClient
NewProductGroupClientWithBaseURI creates an instance of the ProductGroupClient 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 (client ProductGroupClient) CheckEntityExists(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (result autorest.Response, err error)
CheckEntityExists checks that Group entity specified by identifier is associated with the Product entity. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. groupID - group identifier. Must be unique in the current API Management service instance.
func (client ProductGroupClient) CheckEntityExistsPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (*http.Request, error)
CheckEntityExistsPreparer prepares the CheckEntityExists request.
func (client ProductGroupClient) CheckEntityExistsResponder(resp *http.Response) (result autorest.Response, err error)
CheckEntityExistsResponder handles the response to the CheckEntityExists request. The method always closes the http.Response Body.
func (client ProductGroupClient) CheckEntityExistsSender(req *http.Request) (*http.Response, error)
CheckEntityExistsSender sends the CheckEntityExists request. The method will close the http.Response Body if it receives an error.
func (client ProductGroupClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (result GroupContract, err error)
CreateOrUpdate adds the association between the specified developer group with the specified product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. groupID - group identifier. Must be unique in the current API Management service instance.
func (client ProductGroupClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ProductGroupClient) CreateOrUpdateResponder(resp *http.Response) (result GroupContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ProductGroupClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ProductGroupClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (result autorest.Response, err error)
Delete deletes the association between the specified group and product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. groupID - group identifier. Must be unique in the current API Management service instance.
func (client ProductGroupClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, groupID string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ProductGroupClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client ProductGroupClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ProductGroupClient) ListByProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result GroupCollectionPage, err error)
ListByProduct lists the collection of developer groups associated with the specified product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | type | eq, ne | N/A | top - number of records to return. skip - number of records to skip.
func (client ProductGroupClient) ListByProductComplete(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result GroupCollectionIterator, err error)
ListByProductComplete enumerates all values, automatically crossing page boundaries as required.
func (client ProductGroupClient) ListByProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByProductPreparer prepares the ListByProduct request.
func (client ProductGroupClient) ListByProductResponder(resp *http.Response) (result GroupCollection, err error)
ListByProductResponder handles the response to the ListByProduct request. The method always closes the http.Response Body.
func (client ProductGroupClient) ListByProductSender(req *http.Request) (*http.Response, error)
ListByProductSender sends the ListByProduct request. The method will close the http.Response Body if it receives an error.
ProductPolicyClient is the apiManagement Client
type ProductPolicyClient struct {
BaseClient
}
func NewProductPolicyClient(subscriptionID string) ProductPolicyClient
NewProductPolicyClient creates an instance of the ProductPolicyClient client.
func NewProductPolicyClientWithBaseURI(baseURI string, subscriptionID string) ProductPolicyClient
NewProductPolicyClientWithBaseURI creates an instance of the ProductPolicyClient 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 (client ProductPolicyClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters PolicyContract, ifMatch string) (result PolicyContract, err error)
CreateOrUpdate creates or updates policy configuration for the Product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. parameters - the policy contents to apply. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client ProductPolicyClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, parameters PolicyContract, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ProductPolicyClient) CreateOrUpdateResponder(resp *http.Response) (result PolicyContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ProductPolicyClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ProductPolicyClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, productID string, ifMatch string) (result autorest.Response, err error)
Delete deletes the policy configuration at the Product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client ProductPolicyClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ProductPolicyClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client ProductPolicyClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ProductPolicyClient) Get(ctx context.Context, resourceGroupName string, serviceName string, productID string) (result PolicyContract, err error)
Get get the policy configuration at the Product level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance.
func (client ProductPolicyClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, productID string) (result autorest.Response, err error)
GetEntityTag get the ETag of the policy configuration at the Product level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance.
func (client ProductPolicyClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client ProductPolicyClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client ProductPolicyClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client ProductPolicyClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ProductPolicyClient) GetResponder(resp *http.Response) (result PolicyContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client ProductPolicyClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ProductPolicyClient) ListByProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string) (result PolicyCollection, err error)
ListByProduct get the policy configuration at the Product level. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance.
func (client ProductPolicyClient) ListByProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string) (*http.Request, error)
ListByProductPreparer prepares the ListByProduct request.
func (client ProductPolicyClient) ListByProductResponder(resp *http.Response) (result PolicyCollection, err error)
ListByProductResponder handles the response to the ListByProduct request. The method always closes the http.Response Body.
func (client ProductPolicyClient) ListByProductSender(req *http.Request) (*http.Response, error)
ListByProductSender sends the ListByProduct request. The method will close the http.Response Body if it receives an error.
ProductState enumerates the values for product state.
type ProductState string
const (
// NotPublished ...
NotPublished ProductState = "notPublished"
// Published ...
Published ProductState = "published"
)
func PossibleProductStateValues() []ProductState
PossibleProductStateValues returns an array of possible values for the ProductState const type.
ProductSubscriptionsClient is the apiManagement Client
type ProductSubscriptionsClient struct {
BaseClient
}
func NewProductSubscriptionsClient(subscriptionID string) ProductSubscriptionsClient
NewProductSubscriptionsClient creates an instance of the ProductSubscriptionsClient client.
func NewProductSubscriptionsClientWithBaseURI(baseURI string, subscriptionID string) ProductSubscriptionsClient
NewProductSubscriptionsClientWithBaseURI creates an instance of the ProductSubscriptionsClient 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 (client ProductSubscriptionsClient) List(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionPage, err error)
List lists the collection of subscriptions to the specified product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |--------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | top - number of records to return. skip - number of records to skip.
func (client ProductSubscriptionsClient) ListComplete(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ProductSubscriptionsClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)
ListPreparer prepares the List request.
func (client ProductSubscriptionsClient) ListResponder(resp *http.Response) (result SubscriptionCollection, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ProductSubscriptionsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
ProductTagResourceContractProperties product profile.
type ProductTagResourceContractProperties struct {
// ID - Identifier of the product in the form of /products/{productId}
ID *string `json:"id,omitempty"`
// Name - Product name.
Name *string `json:"name,omitempty"`
// Description - Product description. May include HTML formatting tags.
Description *string `json:"description,omitempty"`
// Terms - Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
Terms *string `json:"terms,omitempty"`
// SubscriptionRequired - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
SubscriptionRequired *bool `json:"subscriptionRequired,omitempty"`
// ApprovalRequired - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.
ApprovalRequired *bool `json:"approvalRequired,omitempty"`
// SubscriptionsLimit - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.
SubscriptionsLimit *int32 `json:"subscriptionsLimit,omitempty"`
// State - whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Possible values include: 'NotPublished', 'Published'
State ProductState `json:"state,omitempty"`
}
ProductUpdateParameters product Update parameters.
type ProductUpdateParameters struct {
// ProductUpdateProperties - Product entity Update contract properties.
*ProductUpdateProperties `json:"properties,omitempty"`
}
func (pup ProductUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProductUpdateParameters.
func (pup *ProductUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ProductUpdateParameters struct.
ProductUpdateProperties parameters supplied to the Update Product operation.
type ProductUpdateProperties struct {
// DisplayName - Product name.
DisplayName *string `json:"displayName,omitempty"`
// Description - Product description. May include HTML formatting tags.
Description *string `json:"description,omitempty"`
// Terms - Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
Terms *string `json:"terms,omitempty"`
// SubscriptionRequired - Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
SubscriptionRequired *bool `json:"subscriptionRequired,omitempty"`
// ApprovalRequired - whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.
ApprovalRequired *bool `json:"approvalRequired,omitempty"`
// SubscriptionsLimit - Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true.
SubscriptionsLimit *int32 `json:"subscriptionsLimit,omitempty"`
// State - whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Possible values include: 'NotPublished', 'Published'
State ProductState `json:"state,omitempty"`
}
PropertyClient is the apiManagement Client
type PropertyClient struct {
BaseClient
}
func NewPropertyClient(subscriptionID string) PropertyClient
NewPropertyClient creates an instance of the PropertyClient client.
func NewPropertyClientWithBaseURI(baseURI string, subscriptionID string) PropertyClient
NewPropertyClientWithBaseURI creates an instance of the PropertyClient 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 (client PropertyClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, propID string, parameters PropertyContract, ifMatch string) (result PropertyContract, err error)
CreateOrUpdate creates or updates a property. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. propID - identifier of the property. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client PropertyClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, propID string, parameters PropertyContract, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client PropertyClient) CreateOrUpdateResponder(resp *http.Response) (result PropertyContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client PropertyClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client PropertyClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, propID string, ifMatch string) (result autorest.Response, err error)
Delete deletes specific property from the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. propID - identifier of the property. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client PropertyClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, propID string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client PropertyClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client PropertyClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client PropertyClient) Get(ctx context.Context, resourceGroupName string, serviceName string, propID string) (result PropertyContract, err error)
Get gets the details of the property specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. propID - identifier of the property.
func (client PropertyClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, propID string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the property specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. propID - identifier of the property.
func (client PropertyClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, propID string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client PropertyClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client PropertyClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client PropertyClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, propID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client PropertyClient) GetResponder(resp *http.Response) (result PropertyContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client PropertyClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client PropertyClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result PropertyCollectionPage, err error)
ListByService lists a collection of properties defined within a service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------|------------------------|-------------------------------------------------------| | tags | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client PropertyClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result PropertyCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client PropertyClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client PropertyClient) ListByServiceResponder(resp *http.Response) (result PropertyCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client PropertyClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
func (client PropertyClient) Update(ctx context.Context, resourceGroupName string, serviceName string, propID string, parameters PropertyUpdateParameters, ifMatch string) (result autorest.Response, err error)
Update updates the specific property. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. propID - identifier of the property. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client PropertyClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, propID string, parameters PropertyUpdateParameters, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client PropertyClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client PropertyClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
PropertyCollection paged Property list representation.
type PropertyCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]PropertyContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (pc PropertyCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
PropertyCollectionIterator provides access to a complete listing of PropertyContract values.
type PropertyCollectionIterator struct {
// contains filtered or unexported fields
}
func NewPropertyCollectionIterator(page PropertyCollectionPage) PropertyCollectionIterator
Creates a new instance of the PropertyCollectionIterator type.
func (iter *PropertyCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *PropertyCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter PropertyCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter PropertyCollectionIterator) Response() PropertyCollection
Response returns the raw server response from the last page request.
func (iter PropertyCollectionIterator) Value() PropertyContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
PropertyCollectionPage contains a page of PropertyContract values.
type PropertyCollectionPage struct {
// contains filtered or unexported fields
}
func NewPropertyCollectionPage(cur PropertyCollection, getNextPage func(context.Context, PropertyCollection) (PropertyCollection, error)) PropertyCollectionPage
Creates a new instance of the PropertyCollectionPage type.
func (page *PropertyCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *PropertyCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page PropertyCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page PropertyCollectionPage) Response() PropertyCollection
Response returns the raw server response from the last page request.
func (page PropertyCollectionPage) Values() []PropertyContract
Values returns the slice of values for the current page or nil if there are no values.
PropertyContract property details.
type PropertyContract struct {
autorest.Response `json:"-"`
// PropertyContractProperties - Property entity contract properties.
*PropertyContractProperties `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"`
}
func (pc PropertyContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PropertyContract.
func (pc *PropertyContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PropertyContract struct.
PropertyContractProperties property Contract properties.
type PropertyContractProperties struct {
// DisplayName - Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
DisplayName *string `json:"displayName,omitempty"`
// Value - Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.
Value *string `json:"value,omitempty"`
// Tags - Optional tags that when provided can be used to filter the property list.
Tags *[]string `json:"tags,omitempty"`
// Secret - Determines whether the value is a secret and should be encrypted or not. Default value is false.
Secret *bool `json:"secret,omitempty"`
}
PropertyEntityBaseParameters property Entity Base Parameters set.
type PropertyEntityBaseParameters struct {
// Tags - Optional tags that when provided can be used to filter the property list.
Tags *[]string `json:"tags,omitempty"`
// Secret - Determines whether the value is a secret and should be encrypted or not. Default value is false.
Secret *bool `json:"secret,omitempty"`
}
PropertyUpdateParameterProperties property Contract properties.
type PropertyUpdateParameterProperties struct {
// DisplayName - Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters.
DisplayName *string `json:"displayName,omitempty"`
// Value - Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace.
Value *string `json:"value,omitempty"`
// Tags - Optional tags that when provided can be used to filter the property list.
Tags *[]string `json:"tags,omitempty"`
// Secret - Determines whether the value is a secret and should be encrypted or not. Default value is false.
Secret *bool `json:"secret,omitempty"`
}
PropertyUpdateParameters property update Parameters.
type PropertyUpdateParameters struct {
// PropertyUpdateParameterProperties - Property entity Update contract properties.
*PropertyUpdateParameterProperties `json:"properties,omitempty"`
}
func (pup PropertyUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PropertyUpdateParameters.
func (pup *PropertyUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PropertyUpdateParameters struct.
Protocol enumerates the values for protocol.
type Protocol string
const (
// ProtocolHTTP ...
ProtocolHTTP Protocol = "http"
// ProtocolHTTPS ...
ProtocolHTTPS Protocol = "https"
)
func PossibleProtocolValues() []Protocol
PossibleProtocolValues returns an array of possible values for the Protocol const type.
QuotaByCounterKeysClient is the apiManagement Client
type QuotaByCounterKeysClient struct {
BaseClient
}
func NewQuotaByCounterKeysClient(subscriptionID string) QuotaByCounterKeysClient
NewQuotaByCounterKeysClient creates an instance of the QuotaByCounterKeysClient client.
func NewQuotaByCounterKeysClientWithBaseURI(baseURI string, subscriptionID string) QuotaByCounterKeysClient
NewQuotaByCounterKeysClientWithBaseURI creates an instance of the QuotaByCounterKeysClient 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 (client QuotaByCounterKeysClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string) (result QuotaCounterCollection, err error)
ListByService lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. quotaCounterKey - quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key
func (client QuotaByCounterKeysClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client QuotaByCounterKeysClient) ListByServiceResponder(resp *http.Response) (result QuotaCounterCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client QuotaByCounterKeysClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
func (client QuotaByCounterKeysClient) Update(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string, parameters QuotaCounterValueContractProperties) (result autorest.Response, err error)
Update updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. quotaCounterKey - quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key parameters - the value of the quota counter to be applied to all quota counter periods.
func (client QuotaByCounterKeysClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string, parameters QuotaCounterValueContractProperties) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client QuotaByCounterKeysClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client QuotaByCounterKeysClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
QuotaByPeriodKeysClient is the apiManagement Client
type QuotaByPeriodKeysClient struct {
BaseClient
}
func NewQuotaByPeriodKeysClient(subscriptionID string) QuotaByPeriodKeysClient
NewQuotaByPeriodKeysClient creates an instance of the QuotaByPeriodKeysClient client.
func NewQuotaByPeriodKeysClientWithBaseURI(baseURI string, subscriptionID string) QuotaByPeriodKeysClient
NewQuotaByPeriodKeysClientWithBaseURI creates an instance of the QuotaByPeriodKeysClient 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 (client QuotaByPeriodKeysClient) Get(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string, quotaPeriodKey string) (result QuotaCounterContract, err error)
Get gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. quotaCounterKey - quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key quotaPeriodKey - quota period key identifier.
func (client QuotaByPeriodKeysClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string, quotaPeriodKey string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client QuotaByPeriodKeysClient) GetResponder(resp *http.Response) (result QuotaCounterContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client QuotaByPeriodKeysClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client QuotaByPeriodKeysClient) Update(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string, quotaPeriodKey string, parameters QuotaCounterValueContractProperties) (result autorest.Response, err error)
Update updates an existing quota counter value in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. quotaCounterKey - quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key quotaPeriodKey - quota period key identifier. parameters - the value of the Quota counter to be applied on the specified period.
func (client QuotaByPeriodKeysClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, quotaCounterKey string, quotaPeriodKey string, parameters QuotaCounterValueContractProperties) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client QuotaByPeriodKeysClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client QuotaByPeriodKeysClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
QuotaCounterCollection paged Quota Counter list representation.
type QuotaCounterCollection struct {
autorest.Response `json:"-"`
// Value - Quota counter values.
Value *[]QuotaCounterContract `json:"value,omitempty"`
// Count - Total record count number across all pages.
Count *int64 `json:"count,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
QuotaCounterContract quota counter details.
type QuotaCounterContract struct {
autorest.Response `json:"-"`
// CounterKey - The Key value of the Counter. Must not be empty.
CounterKey *string `json:"counterKey,omitempty"`
// PeriodKey - Identifier of the Period for which the counter was collected. Must not be empty.
PeriodKey *string `json:"periodKey,omitempty"`
// PeriodStartTime - The date of the start of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
PeriodStartTime *date.Time `json:"periodStartTime,omitempty"`
// PeriodEndTime - The date of the end of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
PeriodEndTime *date.Time `json:"periodEndTime,omitempty"`
// Value - Quota Value Properties
Value *QuotaCounterValueContractProperties `json:"value,omitempty"`
}
QuotaCounterValueContract quota counter value details.
type QuotaCounterValueContract struct {
// QuotaCounterValueContractProperties - Quota counter Value Properties.
*QuotaCounterValueContractProperties `json:"value,omitempty"`
}
func (qcvc QuotaCounterValueContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for QuotaCounterValueContract.
func (qcvc *QuotaCounterValueContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for QuotaCounterValueContract struct.
QuotaCounterValueContractProperties quota counter value details.
type QuotaCounterValueContractProperties struct {
// CallsCount - Number of times Counter was called.
CallsCount *int32 `json:"callsCount,omitempty"`
// KbTransferred - Data Transferred in KiloBytes.
KbTransferred *float64 `json:"kbTransferred,omitempty"`
}
RecipientEmailCollection paged Recipient User list representation.
type RecipientEmailCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]RecipientEmailContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
RecipientEmailContract recipient Email details.
type RecipientEmailContract struct {
autorest.Response `json:"-"`
// RecipientEmailContractProperties - Recipient Email contract properties.
*RecipientEmailContractProperties `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"`
}
func (rec RecipientEmailContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RecipientEmailContract.
func (rec *RecipientEmailContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RecipientEmailContract struct.
RecipientEmailContractProperties recipient Email Contract Properties.
type RecipientEmailContractProperties struct {
// Email - User Email subscribed to notification.
Email *string `json:"email,omitempty"`
}
RecipientUserCollection paged Recipient User list representation.
type RecipientUserCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]RecipientUserContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
RecipientUserContract recipient User details.
type RecipientUserContract struct {
autorest.Response `json:"-"`
// RecipientUsersContractProperties - Recipient User entity contract properties.
*RecipientUsersContractProperties `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"`
}
func (ruc RecipientUserContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RecipientUserContract.
func (ruc *RecipientUserContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RecipientUserContract struct.
RecipientUsersContractProperties recipient User Contract Properties.
type RecipientUsersContractProperties struct {
// UserID - API Management UserId subscribed to notification.
UserID *string `json:"userId,omitempty"`
}
RecipientsContractProperties notification Parameter contract.
type RecipientsContractProperties struct {
// Emails - List of Emails subscribed for the notification.
Emails *[]string `json:"emails,omitempty"`
// Users - List of Users subscribed for the notification.
Users *[]string `json:"users,omitempty"`
}
RegionContract region profile.
type RegionContract struct {
// Name - READ-ONLY; Region name.
Name *string `json:"name,omitempty"`
// IsMasterRegion - whether Region is the master region.
IsMasterRegion *bool `json:"isMasterRegion,omitempty"`
// IsDeleted - whether Region is deleted.
IsDeleted *bool `json:"isDeleted,omitempty"`
}
func (rc RegionContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RegionContract.
RegionListResult lists Regions operation response details.
type RegionListResult struct {
autorest.Response `json:"-"`
// Value - Lists of Regions.
Value *[]RegionContract `json:"value,omitempty"`
// Count - Total record count number across all pages.
Count *int64 `json:"count,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (rlr RegionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
RegionListResultIterator provides access to a complete listing of RegionContract values.
type RegionListResultIterator struct {
// contains filtered or unexported fields
}
func NewRegionListResultIterator(page RegionListResultPage) RegionListResultIterator
Creates a new instance of the RegionListResultIterator type.
func (iter *RegionListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *RegionListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter RegionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter RegionListResultIterator) Response() RegionListResult
Response returns the raw server response from the last page request.
func (iter RegionListResultIterator) Value() RegionContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
RegionListResultPage contains a page of RegionContract values.
type RegionListResultPage struct {
// contains filtered or unexported fields
}
func NewRegionListResultPage(cur RegionListResult, getNextPage func(context.Context, RegionListResult) (RegionListResult, error)) RegionListResultPage
Creates a new instance of the RegionListResultPage type.
func (page *RegionListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *RegionListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page RegionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page RegionListResultPage) Response() RegionListResult
Response returns the raw server response from the last page request.
func (page RegionListResultPage) Values() []RegionContract
Values returns the slice of values for the current page or nil if there are no values.
RegionsClient is the apiManagement Client
type RegionsClient struct {
BaseClient
}
func NewRegionsClient(subscriptionID string) RegionsClient
NewRegionsClient creates an instance of the RegionsClient client.
func NewRegionsClientWithBaseURI(baseURI string, subscriptionID string) RegionsClient
NewRegionsClientWithBaseURI creates an instance of the RegionsClient 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 (client RegionsClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string) (result RegionListResultPage, err error)
ListByService lists all azure regions in which the service exists. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client RegionsClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string) (result RegionListResultIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client RegionsClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client RegionsClient) ListByServiceResponder(resp *http.Response) (result RegionListResult, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client RegionsClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
RegistrationDelegationSettingsProperties user registration delegation settings properties.
type RegistrationDelegationSettingsProperties struct {
// Enabled - Enable or disable delegation for user registration.
Enabled *bool `json:"enabled,omitempty"`
}
ReportCollection paged Report records list representation.
type ReportCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]ReportRecordContract `json:"value,omitempty"`
// Count - Total record count number across all pages.
Count *int64 `json:"count,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (rc ReportCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ReportCollectionIterator provides access to a complete listing of ReportRecordContract values.
type ReportCollectionIterator struct {
// contains filtered or unexported fields
}
func NewReportCollectionIterator(page ReportCollectionPage) ReportCollectionIterator
Creates a new instance of the ReportCollectionIterator type.
func (iter *ReportCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ReportCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ReportCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ReportCollectionIterator) Response() ReportCollection
Response returns the raw server response from the last page request.
func (iter ReportCollectionIterator) Value() ReportRecordContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ReportCollectionPage contains a page of ReportRecordContract values.
type ReportCollectionPage struct {
// contains filtered or unexported fields
}
func NewReportCollectionPage(cur ReportCollection, getNextPage func(context.Context, ReportCollection) (ReportCollection, error)) ReportCollectionPage
Creates a new instance of the ReportCollectionPage type.
func (page *ReportCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ReportCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ReportCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ReportCollectionPage) Response() ReportCollection
Response returns the raw server response from the last page request.
func (page ReportCollectionPage) Values() []ReportRecordContract
Values returns the slice of values for the current page or nil if there are no values.
ReportRecordContract report data.
type ReportRecordContract struct {
// Name - Name depending on report endpoint specifies product, API, operation or developer name.
Name *string `json:"name,omitempty"`
// Timestamp - Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
Timestamp *date.Time `json:"timestamp,omitempty"`
// Interval - Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).
Interval *string `json:"interval,omitempty"`
// Country - Country to which this record data is related.
Country *string `json:"country,omitempty"`
// Region - Country region to which this record data is related.
Region *string `json:"region,omitempty"`
// Zip - Zip code to which this record data is related.
Zip *string `json:"zip,omitempty"`
// UserID - READ-ONLY; User identifier path. /users/{userId}
UserID *string `json:"userId,omitempty"`
// ProductID - READ-ONLY; Product identifier path. /products/{productId}
ProductID *string `json:"productId,omitempty"`
// APIID - API identifier path. /apis/{apiId}
APIID *string `json:"apiId,omitempty"`
// OperationID - Operation identifier path. /apis/{apiId}/operations/{operationId}
OperationID *string `json:"operationId,omitempty"`
// APIRegion - API region identifier.
APIRegion *string `json:"apiRegion,omitempty"`
// SubscriptionID - Subscription identifier path. /subscriptions/{subscriptionId}
SubscriptionID *string `json:"subscriptionId,omitempty"`
// CallCountSuccess - Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect
CallCountSuccess *int32 `json:"callCountSuccess,omitempty"`
// CallCountBlocked - Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests
CallCountBlocked *int32 `json:"callCountBlocked,omitempty"`
// CallCountFailed - Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600
CallCountFailed *int32 `json:"callCountFailed,omitempty"`
// CallCountOther - Number of other calls.
CallCountOther *int32 `json:"callCountOther,omitempty"`
// CallCountTotal - Total number of calls.
CallCountTotal *int32 `json:"callCountTotal,omitempty"`
// Bandwidth - Bandwidth consumed.
Bandwidth *int64 `json:"bandwidth,omitempty"`
// CacheHitCount - Number of times when content was served from cache policy.
CacheHitCount *int32 `json:"cacheHitCount,omitempty"`
// CacheMissCount - Number of times content was fetched from backend.
CacheMissCount *int32 `json:"cacheMissCount,omitempty"`
// APITimeAvg - Average time it took to process request.
APITimeAvg *float64 `json:"apiTimeAvg,omitempty"`
// APITimeMin - Minimum time it took to process request.
APITimeMin *float64 `json:"apiTimeMin,omitempty"`
// APITimeMax - Maximum time it took to process request.
APITimeMax *float64 `json:"apiTimeMax,omitempty"`
// ServiceTimeAvg - Average time it took to process request on backend.
ServiceTimeAvg *float64 `json:"serviceTimeAvg,omitempty"`
// ServiceTimeMin - Minimum time it took to process request on backend.
ServiceTimeMin *float64 `json:"serviceTimeMin,omitempty"`
// ServiceTimeMax - Maximum time it took to process request on backend.
ServiceTimeMax *float64 `json:"serviceTimeMax,omitempty"`
}
func (rrc ReportRecordContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ReportRecordContract.
ReportsClient is the apiManagement Client
type ReportsClient struct {
BaseClient
}
func NewReportsClient(subscriptionID string) ReportsClient
NewReportsClient creates an instance of the ReportsClient client.
func NewReportsClientWithBaseURI(baseURI string, subscriptionID string) ReportsClient
NewReportsClientWithBaseURI creates an instance of the ReportsClient 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 (client ReportsClient) ListByAPI(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)
ListByAPI lists report records by API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.
func (client ReportsClient) ListByAPIComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)
ListByAPIComplete enumerates all values, automatically crossing page boundaries as required.
func (client ReportsClient) ListByAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByAPIPreparer prepares the ListByAPI request.
func (client ReportsClient) ListByAPIResponder(resp *http.Response) (result ReportCollection, err error)
ListByAPIResponder handles the response to the ListByAPI request. The method always closes the http.Response Body.
func (client ReportsClient) ListByAPISender(req *http.Request) (*http.Response, error)
ListByAPISender sends the ListByAPI request. The method will close the http.Response Body if it receives an error.
func (client ReportsClient) ListByGeo(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)
ListByGeo lists report records by geography. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.
func (client ReportsClient) ListByGeoComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)
ListByGeoComplete enumerates all values, automatically crossing page boundaries as required.
func (client ReportsClient) ListByGeoPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByGeoPreparer prepares the ListByGeo request.
func (client ReportsClient) ListByGeoResponder(resp *http.Response) (result ReportCollection, err error)
ListByGeoResponder handles the response to the ListByGeo request. The method always closes the http.Response Body.
func (client ReportsClient) ListByGeoSender(req *http.Request) (*http.Response, error)
ListByGeoSender sends the ListByGeo request. The method will close the http.Response Body if it receives an error.
func (client ReportsClient) ListByOperation(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)
ListByOperation lists report records by API Operations. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.
func (client ReportsClient) ListByOperationComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)
ListByOperationComplete enumerates all values, automatically crossing page boundaries as required.
func (client ReportsClient) ListByOperationPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByOperationPreparer prepares the ListByOperation request.
func (client ReportsClient) ListByOperationResponder(resp *http.Response) (result ReportCollection, err error)
ListByOperationResponder handles the response to the ListByOperation request. The method always closes the http.Response Body.
func (client ReportsClient) ListByOperationSender(req *http.Request) (*http.Response, error)
ListByOperationSender sends the ListByOperation request. The method will close the http.Response Body if it receives an error.
func (client ReportsClient) ListByProduct(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)
ListByProduct lists report records by Product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.
func (client ReportsClient) ListByProductComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)
ListByProductComplete enumerates all values, automatically crossing page boundaries as required.
func (client ReportsClient) ListByProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByProductPreparer prepares the ListByProduct request.
func (client ReportsClient) ListByProductResponder(resp *http.Response) (result ReportCollection, err error)
ListByProductResponder handles the response to the ListByProduct request. The method always closes the http.Response Body.
func (client ReportsClient) ListByProductSender(req *http.Request) (*http.Response, error)
ListByProductSender sends the ListByProduct request. The method will close the http.Response Body if it receives an error.
func (client ReportsClient) ListByRequest(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result RequestReportCollection, err error)
ListByRequest lists report records by Request. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.
func (client ReportsClient) ListByRequestPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByRequestPreparer prepares the ListByRequest request.
func (client ReportsClient) ListByRequestResponder(resp *http.Response) (result RequestReportCollection, err error)
ListByRequestResponder handles the response to the ListByRequest request. The method always closes the http.Response Body.
func (client ReportsClient) ListByRequestSender(req *http.Request) (*http.Response, error)
ListByRequestSender sends the ListByRequest request. The method will close the http.Response Body if it receives an error.
func (client ReportsClient) ListBySubscription(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)
ListBySubscription lists report records by subscription. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.
func (client ReportsClient) ListBySubscriptionComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client ReportsClient) ListBySubscriptionPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client ReportsClient) ListBySubscriptionResponder(resp *http.Response) (result ReportCollection, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client ReportsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (client ReportsClient) ListByTime(ctx context.Context, resourceGroupName string, serviceName string, interval string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)
ListByTime lists report records by Time. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. interval - by time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.
func (client ReportsClient) ListByTimeComplete(ctx context.Context, resourceGroupName string, serviceName string, interval string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)
ListByTimeComplete enumerates all values, automatically crossing page boundaries as required.
func (client ReportsClient) ListByTimePreparer(ctx context.Context, resourceGroupName string, serviceName string, interval string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByTimePreparer prepares the ListByTime request.
func (client ReportsClient) ListByTimeResponder(resp *http.Response) (result ReportCollection, err error)
ListByTimeResponder handles the response to the ListByTime request. The method always closes the http.Response Body.
func (client ReportsClient) ListByTimeSender(req *http.Request) (*http.Response, error)
ListByTimeSender sends the ListByTime request. The method will close the http.Response Body if it receives an error.
func (client ReportsClient) ListByUser(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionPage, err error)
ListByUser lists report records by User. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - the filter to apply on the operation. top - number of records to return. skip - number of records to skip.
func (client ReportsClient) ListByUserComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result ReportCollectionIterator, err error)
ListByUserComplete enumerates all values, automatically crossing page boundaries as required.
func (client ReportsClient) ListByUserPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByUserPreparer prepares the ListByUser request.
func (client ReportsClient) ListByUserResponder(resp *http.Response) (result ReportCollection, err error)
ListByUserResponder handles the response to the ListByUser request. The method always closes the http.Response Body.
func (client ReportsClient) ListByUserSender(req *http.Request) (*http.Response, error)
ListByUserSender sends the ListByUser request. The method will close the http.Response Body if it receives an error.
RepresentationContract operation request/response representation details.
type RepresentationContract struct {
// ContentType - Specifies a registered or custom content type for this representation, e.g. application/xml.
ContentType *string `json:"contentType,omitempty"`
// Sample - An example of the representation.
Sample *string `json:"sample,omitempty"`
// SchemaID - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
SchemaID *string `json:"schemaId,omitempty"`
// TypeName - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
TypeName *string `json:"typeName,omitempty"`
// FormParameters - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
FormParameters *[]ParameterContract `json:"formParameters,omitempty"`
}
RequestContract operation request details.
type RequestContract struct {
// Description - Operation request description.
Description *string `json:"description,omitempty"`
// QueryParameters - Collection of operation request query parameters.
QueryParameters *[]ParameterContract `json:"queryParameters,omitempty"`
// Headers - Collection of operation request headers.
Headers *[]ParameterContract `json:"headers,omitempty"`
// Representations - Collection of operation request representations.
Representations *[]RepresentationContract `json:"representations,omitempty"`
}
RequestReportCollection paged Report records list representation.
type RequestReportCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]RequestReportRecordContract `json:"value,omitempty"`
// Count - Total record count number across all pages.
Count *int64 `json:"count,omitempty"`
}
RequestReportRecordContract request Report data.
type RequestReportRecordContract struct {
// APIID - API identifier path. /apis/{apiId}
APIID *string `json:"apiId,omitempty"`
// OperationID - Operation identifier path. /apis/{apiId}/operations/{operationId}
OperationID *string `json:"operationId,omitempty"`
// ProductID - READ-ONLY; Product identifier path. /products/{productId}
ProductID *string `json:"productId,omitempty"`
// UserID - READ-ONLY; User identifier path. /users/{userId}
UserID *string `json:"userId,omitempty"`
// Method - The HTTP method associated with this request..
Method *string `json:"method,omitempty"`
// URL - The full URL associated with this request.
URL *string `json:"url,omitempty"`
// IPAddress - The client IP address associated with this request.
IPAddress *string `json:"ipAddress,omitempty"`
// BackendResponseCode - The HTTP status code received by the gateway as a result of forwarding this request to the backend.
BackendResponseCode *string `json:"backendResponseCode,omitempty"`
// ResponseCode - The HTTP status code returned by the gateway.
ResponseCode *int32 `json:"responseCode,omitempty"`
// ResponseSize - The size of the response returned by the gateway.
ResponseSize *int32 `json:"responseSize,omitempty"`
// Timestamp - The date and time when this request was received by the gateway in ISO 8601 format.
Timestamp *date.Time `json:"timestamp,omitempty"`
// Cache - Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend.
Cache *string `json:"cache,omitempty"`
// APITime - The total time it took to process this request.
APITime *float64 `json:"apiTime,omitempty"`
// ServiceTime - he time it took to forward this request to the backend and get the response back.
ServiceTime *float64 `json:"serviceTime,omitempty"`
// APIRegion - Azure region where the gateway that processed this request is located.
APIRegion *string `json:"apiRegion,omitempty"`
// SubscriptionID - Subscription identifier path. /subscriptions/{subscriptionId}
SubscriptionID *string `json:"subscriptionId,omitempty"`
// RequestID - Request Identifier.
RequestID *string `json:"requestId,omitempty"`
// RequestSize - The size of this request..
RequestSize *int32 `json:"requestSize,omitempty"`
}
func (rrrc RequestReportRecordContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RequestReportRecordContract.
Resource the Resource definition.
type Resource struct {
// 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"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
ResourceSku describes an available API Management SKU.
type ResourceSku struct {
// Name - Name of the Sku. Possible values include: 'SkuTypeDeveloper', 'SkuTypeStandard', 'SkuTypePremium', 'SkuTypeBasic'
Name SkuType `json:"name,omitempty"`
}
ResourceSkuCapacity describes scaling information of a SKU.
type ResourceSkuCapacity struct {
// Minimum - READ-ONLY; The minimum capacity.
Minimum *int32 `json:"minimum,omitempty"`
// Maximum - READ-ONLY; The maximum capacity that can be set.
Maximum *int32 `json:"maximum,omitempty"`
// Default - READ-ONLY; The default capacity.
Default *int32 `json:"default,omitempty"`
// ScaleType - READ-ONLY; The scale type applicable to the sku. Possible values include: 'Automatic', 'Manual', 'None'
ScaleType ResourceSkuCapacityScaleType `json:"scaleType,omitempty"`
}
func (rsc ResourceSkuCapacity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceSkuCapacity.
ResourceSkuCapacityScaleType enumerates the values for resource sku capacity scale type.
type ResourceSkuCapacityScaleType string
const (
// Automatic ...
Automatic ResourceSkuCapacityScaleType = "automatic"
// Manual ...
Manual ResourceSkuCapacityScaleType = "manual"
// None ...
None ResourceSkuCapacityScaleType = "none"
)
func PossibleResourceSkuCapacityScaleTypeValues() []ResourceSkuCapacityScaleType
PossibleResourceSkuCapacityScaleTypeValues returns an array of possible values for the ResourceSkuCapacityScaleType const type.
ResourceSkuResult describes an available API Management service SKU.
type ResourceSkuResult struct {
// ResourceType - READ-ONLY; The type of resource the SKU applies to.
ResourceType *string `json:"resourceType,omitempty"`
// Sku - READ-ONLY; Specifies API Management SKU.
Sku *ResourceSku `json:"sku,omitempty"`
// Capacity - READ-ONLY; Specifies the number of API Management units.
Capacity *ResourceSkuCapacity `json:"capacity,omitempty"`
}
func (rsr ResourceSkuResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceSkuResult.
ResourceSkuResults the API Management service SKUs operation response.
type ResourceSkuResults struct {
autorest.Response `json:"-"`
// Value - The list of skus available for the service.
Value *[]ResourceSkuResult `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of API Management service Skus.
NextLink *string `json:"nextLink,omitempty"`
}
func (rsr ResourceSkuResults) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ResourceSkuResultsIterator provides access to a complete listing of ResourceSkuResult values.
type ResourceSkuResultsIterator struct {
// contains filtered or unexported fields
}
func NewResourceSkuResultsIterator(page ResourceSkuResultsPage) ResourceSkuResultsIterator
Creates a new instance of the ResourceSkuResultsIterator type.
func (iter *ResourceSkuResultsIterator) 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 (iter *ResourceSkuResultsIterator) 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 (iter ResourceSkuResultsIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ResourceSkuResultsIterator) Response() ResourceSkuResults
Response returns the raw server response from the last page request.
func (iter ResourceSkuResultsIterator) Value() ResourceSkuResult
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ResourceSkuResultsPage contains a page of ResourceSkuResult values.
type ResourceSkuResultsPage struct {
// contains filtered or unexported fields
}
func NewResourceSkuResultsPage(cur ResourceSkuResults, getNextPage func(context.Context, ResourceSkuResults) (ResourceSkuResults, error)) ResourceSkuResultsPage
Creates a new instance of the ResourceSkuResultsPage type.
func (page *ResourceSkuResultsPage) 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 (page *ResourceSkuResultsPage) 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 (page ResourceSkuResultsPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ResourceSkuResultsPage) Response() ResourceSkuResults
Response returns the raw server response from the last page request.
func (page ResourceSkuResultsPage) Values() []ResourceSkuResult
Values returns the slice of values for the current page or nil if there are no values.
ResponseContract operation response details.
type ResponseContract struct {
// StatusCode - Operation response HTTP status code.
StatusCode *int32 `json:"statusCode,omitempty"`
// Description - Operation response description.
Description *string `json:"description,omitempty"`
// Representations - Collection of operation response representations.
Representations *[]RepresentationContract `json:"representations,omitempty"`
// Headers - Collection of operation response headers.
Headers *[]ParameterContract `json:"headers,omitempty"`
}
SaveConfigurationParameter parameters supplied to the Save Tenant Configuration operation.
type SaveConfigurationParameter struct {
// Branch - The name of the Git branch in which to commit the current configuration snapshot.
Branch *string `json:"branch,omitempty"`
// Force - The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be overwritten.
Force *bool `json:"force,omitempty"`
}
SchemaCollection the response of the list schema operation.
type SchemaCollection struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; Api Schema Contract value.
Value *[]SchemaContract `json:"value,omitempty"`
// NextLink - READ-ONLY; Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (sc SchemaCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (sc SchemaCollection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SchemaCollection.
SchemaCollectionIterator provides access to a complete listing of SchemaContract values.
type SchemaCollectionIterator struct {
// contains filtered or unexported fields
}
func NewSchemaCollectionIterator(page SchemaCollectionPage) SchemaCollectionIterator
Creates a new instance of the SchemaCollectionIterator type.
func (iter *SchemaCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *SchemaCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter SchemaCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SchemaCollectionIterator) Response() SchemaCollection
Response returns the raw server response from the last page request.
func (iter SchemaCollectionIterator) Value() SchemaContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
SchemaCollectionPage contains a page of SchemaContract values.
type SchemaCollectionPage struct {
// contains filtered or unexported fields
}
func NewSchemaCollectionPage(cur SchemaCollection, getNextPage func(context.Context, SchemaCollection) (SchemaCollection, error)) SchemaCollectionPage
Creates a new instance of the SchemaCollectionPage type.
func (page *SchemaCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *SchemaCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page SchemaCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SchemaCollectionPage) Response() SchemaCollection
Response returns the raw server response from the last page request.
func (page SchemaCollectionPage) Values() []SchemaContract
Values returns the slice of values for the current page or nil if there are no values.
SchemaContract schema Contract details.
type SchemaContract struct {
autorest.Response `json:"-"`
// SchemaContractProperties - Properties of the Schema.
*SchemaContractProperties `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"`
}
func (sc SchemaContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SchemaContract.
func (sc *SchemaContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SchemaContract struct.
SchemaContractProperties schema contract Properties.
type SchemaContractProperties struct {
// ContentType - Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).
ContentType *string `json:"contentType,omitempty"`
// SchemaDocumentProperties - Properties of the Schema Document.
*SchemaDocumentProperties `json:"document,omitempty"`
}
func (scp SchemaContractProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SchemaContractProperties.
func (scp *SchemaContractProperties) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SchemaContractProperties struct.
SchemaDocumentProperties schema Document Properties.
type SchemaDocumentProperties struct {
// Value - Json escaped string defining the document representing the Schema.
Value *string `json:"value,omitempty"`
}
ServiceApplyNetworkConfigurationParameters parameter supplied to the Apply Network configuration operation.
type ServiceApplyNetworkConfigurationParameters struct {
// Location - Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required.
Location *string `json:"location,omitempty"`
}
ServiceApplyNetworkConfigurationUpdatesFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ServiceApplyNetworkConfigurationUpdatesFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ServiceClient) (ServiceResource, error)
}
func (future *ServiceApplyNetworkConfigurationUpdatesFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ServiceBackupFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ServiceBackupFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ServiceClient) (ServiceResource, error)
}
func (future *ServiceBackupFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ServiceBackupRestoreParameters parameters supplied to the Backup/Restore of an API Management service operation.
type ServiceBackupRestoreParameters struct {
// StorageAccount - Azure Cloud Storage account (used to place/retrieve the backup) name.
StorageAccount *string `json:"storageAccount,omitempty"`
// AccessKey - Azure Cloud Storage account (used to place/retrieve the backup) access key.
AccessKey *string `json:"accessKey,omitempty"`
// ContainerName - Azure Cloud Storage blob container name used to place/retrieve the backup.
ContainerName *string `json:"containerName,omitempty"`
// BackupName - The name of the backup file to create.
BackupName *string `json:"backupName,omitempty"`
}
ServiceBaseProperties base Properties of an API Management service resource description.
type ServiceBaseProperties struct {
// NotificationSenderEmail - Email address from which the notification will be sent.
NotificationSenderEmail *string `json:"notificationSenderEmail,omitempty"`
// ProvisioningState - READ-ONLY; The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
ProvisioningState *string `json:"provisioningState,omitempty"`
// TargetProvisioningState - READ-ONLY; The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
TargetProvisioningState *string `json:"targetProvisioningState,omitempty"`
// CreatedAtUtc - READ-ONLY; Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
CreatedAtUtc *date.Time `json:"createdAtUtc,omitempty"`
// GatewayURL - READ-ONLY; Gateway URL of the API Management service.
GatewayURL *string `json:"gatewayUrl,omitempty"`
// GatewayRegionalURL - READ-ONLY; Gateway URL of the API Management service in the Default Region.
GatewayRegionalURL *string `json:"gatewayRegionalUrl,omitempty"`
// PortalURL - READ-ONLY; Publisher portal endpoint Url of the API Management service.
PortalURL *string `json:"portalUrl,omitempty"`
// ManagementAPIURL - READ-ONLY; Management API endpoint URL of the API Management service.
ManagementAPIURL *string `json:"managementApiUrl,omitempty"`
// ScmURL - READ-ONLY; SCM endpoint URL of the API Management service.
ScmURL *string `json:"scmUrl,omitempty"`
// HostnameConfigurations - Custom hostname configuration of the API Management service.
HostnameConfigurations *[]HostnameConfiguration `json:"hostnameConfigurations,omitempty"`
// PublicIPAddresses - READ-ONLY; Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU.
PublicIPAddresses *[]string `json:"publicIPAddresses,omitempty"`
// PrivateIPAddresses - READ-ONLY; Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU.
PrivateIPAddresses *[]string `json:"privateIPAddresses,omitempty"`
// VirtualNetworkConfiguration - Virtual network configuration of the API Management service.
VirtualNetworkConfiguration *VirtualNetworkConfiguration `json:"virtualNetworkConfiguration,omitempty"`
// AdditionalLocations - Additional datacenter locations of the API Management service.
AdditionalLocations *[]AdditionalLocation `json:"additionalLocations,omitempty"`
// CustomProperties - Custom properties of the API Management service. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1 and setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.
CustomProperties map[string]*string `json:"customProperties"`
// Certificates - List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
Certificates *[]CertificateConfiguration `json:"certificates,omitempty"`
// VirtualNetworkType - The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. Possible values include: 'VirtualNetworkTypeNone', 'VirtualNetworkTypeExternal', 'VirtualNetworkTypeInternal'
VirtualNetworkType VirtualNetworkType `json:"virtualNetworkType,omitempty"`
}
func (sbp ServiceBaseProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceBaseProperties.
ServiceCheckNameAvailabilityParameters parameters supplied to the CheckNameAvailability operation.
type ServiceCheckNameAvailabilityParameters struct {
// Name - The name to check for availability.
Name *string `json:"name,omitempty"`
}
ServiceClient is the apiManagement Client
type ServiceClient struct {
BaseClient
}
func NewServiceClient(subscriptionID string) ServiceClient
NewServiceClient creates an instance of the ServiceClient client.
func NewServiceClientWithBaseURI(baseURI string, subscriptionID string) ServiceClient
NewServiceClientWithBaseURI creates an instance of the ServiceClient 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 (client ServiceClient) ApplyNetworkConfigurationUpdates(ctx context.Context, resourceGroupName string, serviceName string, parameters *ServiceApplyNetworkConfigurationParameters) (result ServiceApplyNetworkConfigurationUpdatesFuture, err error)
ApplyNetworkConfigurationUpdates updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated network settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region.
func (client ServiceClient) ApplyNetworkConfigurationUpdatesPreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters *ServiceApplyNetworkConfigurationParameters) (*http.Request, error)
ApplyNetworkConfigurationUpdatesPreparer prepares the ApplyNetworkConfigurationUpdates request.
func (client ServiceClient) ApplyNetworkConfigurationUpdatesResponder(resp *http.Response) (result ServiceResource, err error)
ApplyNetworkConfigurationUpdatesResponder handles the response to the ApplyNetworkConfigurationUpdates request. The method always closes the http.Response Body.
func (client ServiceClient) ApplyNetworkConfigurationUpdatesSender(req *http.Request) (future ServiceApplyNetworkConfigurationUpdatesFuture, err error)
ApplyNetworkConfigurationUpdatesSender sends the ApplyNetworkConfigurationUpdates request. The method will close the http.Response Body if it receives an error.
func (client ServiceClient) Backup(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceBackupRestoreParameters) (result ServiceBackupFuture, err error)
Backup creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to the ApiManagementService_Backup operation.
func (client ServiceClient) BackupPreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceBackupRestoreParameters) (*http.Request, error)
BackupPreparer prepares the Backup request.
func (client ServiceClient) BackupResponder(resp *http.Response) (result ServiceResource, err error)
BackupResponder handles the response to the Backup request. The method always closes the http.Response Body.
func (client ServiceClient) BackupSender(req *http.Request) (future ServiceBackupFuture, err error)
BackupSender sends the Backup request. The method will close the http.Response Body if it receives an error.
func (client ServiceClient) CheckNameAvailability(ctx context.Context, parameters ServiceCheckNameAvailabilityParameters) (result ServiceNameAvailabilityResult, err error)
CheckNameAvailability checks availability and correctness of a name for an API Management service. Parameters: parameters - parameters supplied to the CheckNameAvailability operation.
func (client ServiceClient) CheckNameAvailabilityPreparer(ctx context.Context, parameters ServiceCheckNameAvailabilityParameters) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
func (client ServiceClient) CheckNameAvailabilityResponder(resp *http.Response) (result ServiceNameAvailabilityResult, err error)
CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.
func (client ServiceClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.
func (client ServiceClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceResource) (result ServiceCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates an API Management service. This is long running operation and could take several minutes to complete. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to the CreateOrUpdate API Management service operation.
func (client ServiceClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceResource) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ServiceClient) CreateOrUpdateResponder(resp *http.Response) (result ServiceResource, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ServiceClient) CreateOrUpdateSender(req *http.Request) (future ServiceCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ServiceClient) Delete(ctx context.Context, resourceGroupName string, serviceName string) (result autorest.Response, err error)
Delete deletes an existing API Management service. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client ServiceClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ServiceClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client ServiceClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ServiceClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result ServiceResource, err error)
Get gets an API Management service resource description. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client ServiceClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ServiceClient) GetResponder(resp *http.Response) (result ServiceResource, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client ServiceClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ServiceClient) GetSsoToken(ctx context.Context, resourceGroupName string, serviceName string) (result ServiceGetSsoTokenResult, err error)
GetSsoToken gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client ServiceClient) GetSsoTokenPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
GetSsoTokenPreparer prepares the GetSsoToken request.
func (client ServiceClient) GetSsoTokenResponder(resp *http.Response) (result ServiceGetSsoTokenResult, err error)
GetSsoTokenResponder handles the response to the GetSsoToken request. The method always closes the http.Response Body.
func (client ServiceClient) GetSsoTokenSender(req *http.Request) (*http.Response, error)
GetSsoTokenSender sends the GetSsoToken request. The method will close the http.Response Body if it receives an error.
func (client ServiceClient) List(ctx context.Context) (result ServiceListResultPage, err error)
List lists all API Management services within an Azure subscription.
func (client ServiceClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ServiceListResultPage, err error)
ListByResourceGroup list all API Management services within a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client ServiceClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ServiceListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client ServiceClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client ServiceClient) ListByResourceGroupResponder(resp *http.Response) (result ServiceListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client ServiceClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client ServiceClient) ListComplete(ctx context.Context) (result ServiceListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ServiceClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client ServiceClient) ListResponder(resp *http.Response) (result ServiceListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ServiceClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client ServiceClient) Restore(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceBackupRestoreParameters) (result ServiceRestoreFuture, err error)
Restore restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to the Restore API Management service from backup operation.
func (client ServiceClient) RestorePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceBackupRestoreParameters) (*http.Request, error)
RestorePreparer prepares the Restore request.
func (client ServiceClient) RestoreResponder(resp *http.Response) (result ServiceResource, err error)
RestoreResponder handles the response to the Restore request. The method always closes the http.Response Body.
func (client ServiceClient) RestoreSender(req *http.Request) (future ServiceRestoreFuture, err error)
RestoreSender sends the Restore request. The method will close the http.Response Body if it receives an error.
func (client ServiceClient) Update(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUpdateParameters) (result ServiceUpdateFuture, err error)
Update updates an existing API Management service. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to the CreateOrUpdate API Management service operation.
func (client ServiceClient) UpdateHostname(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUpdateHostnameParameters) (result ServiceUpdateHostnameFuture, err error)
UpdateHostname creates, updates, or deletes the custom hostnames for an API Management service. The custom hostname can be applied to the Proxy and Portal endpoint. This is a long running operation and could take several minutes to complete. This operation will be deprecated in the next version update. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to the UpdateHostname operation.
func (client ServiceClient) UpdateHostnamePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUpdateHostnameParameters) (*http.Request, error)
UpdateHostnamePreparer prepares the UpdateHostname request.
func (client ServiceClient) UpdateHostnameResponder(resp *http.Response) (result ServiceResource, err error)
UpdateHostnameResponder handles the response to the UpdateHostname request. The method always closes the http.Response Body.
func (client ServiceClient) UpdateHostnameSender(req *http.Request) (future ServiceUpdateHostnameFuture, err error)
UpdateHostnameSender sends the UpdateHostname request. The method will close the http.Response Body if it receives an error.
func (client ServiceClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUpdateParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client ServiceClient) UpdateResponder(resp *http.Response) (result ServiceResource, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client ServiceClient) UpdateSender(req *http.Request) (future ServiceUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
func (client ServiceClient) UploadCertificate(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUploadCertificateParameters) (result CertificateInformation, err error)
UploadCertificate upload Custom Domain SSL certificate for an API Management service. This operation will be deprecated in future releases. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to the Upload SSL certificate for an API Management service operation.
func (client ServiceClient) UploadCertificatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceUploadCertificateParameters) (*http.Request, error)
UploadCertificatePreparer prepares the UploadCertificate request.
func (client ServiceClient) UploadCertificateResponder(resp *http.Response) (result CertificateInformation, err error)
UploadCertificateResponder handles the response to the UploadCertificate request. The method always closes the http.Response Body.
func (client ServiceClient) UploadCertificateSender(req *http.Request) (*http.Response, error)
UploadCertificateSender sends the UploadCertificate request. The method will close the http.Response Body if it receives an error.
ServiceCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ServiceCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ServiceClient) (ServiceResource, error)
}
func (future *ServiceCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ServiceGetSsoTokenResult the response of the GetSsoToken operation.
type ServiceGetSsoTokenResult struct {
autorest.Response `json:"-"`
// RedirectURI - Redirect URL to the Publisher Portal containing the SSO token.
RedirectURI *string `json:"redirectUri,omitempty"`
}
ServiceIdentity identity properties of the Api Management service resource.
type ServiceIdentity struct {
// Type - The identity type. Currently the only supported type is 'SystemAssigned'.
Type *string `json:"type,omitempty"`
// PrincipalID - READ-ONLY; The principal id of the identity.
PrincipalID *uuid.UUID `json:"principalId,omitempty"`
// TenantID - READ-ONLY; The client tenant id of the identity.
TenantID *uuid.UUID `json:"tenantId,omitempty"`
}
func (si ServiceIdentity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceIdentity.
ServiceListResult the response of the List API Management services operation.
type ServiceListResult struct {
autorest.Response `json:"-"`
// Value - Result of the List API Management services operation.
Value *[]ServiceResource `json:"value,omitempty"`
// NextLink - Link to the next set of results. Not empty if Value contains incomplete list of API Management services.
NextLink *string `json:"nextLink,omitempty"`
}
func (slr ServiceListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ServiceListResultIterator provides access to a complete listing of ServiceResource values.
type ServiceListResultIterator struct {
// contains filtered or unexported fields
}
func NewServiceListResultIterator(page ServiceListResultPage) ServiceListResultIterator
Creates a new instance of the ServiceListResultIterator type.
func (iter *ServiceListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *ServiceListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter ServiceListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ServiceListResultIterator) Response() ServiceListResult
Response returns the raw server response from the last page request.
func (iter ServiceListResultIterator) Value() ServiceResource
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
ServiceListResultPage contains a page of ServiceResource values.
type ServiceListResultPage struct {
// contains filtered or unexported fields
}
func NewServiceListResultPage(cur ServiceListResult, getNextPage func(context.Context, ServiceListResult) (ServiceListResult, error)) ServiceListResultPage
Creates a new instance of the ServiceListResultPage type.
func (page *ServiceListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *ServiceListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page ServiceListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ServiceListResultPage) Response() ServiceListResult
Response returns the raw server response from the last page request.
func (page ServiceListResultPage) Values() []ServiceResource
Values returns the slice of values for the current page or nil if there are no values.
ServiceNameAvailabilityResult response of the CheckNameAvailability operation.
type ServiceNameAvailabilityResult struct {
autorest.Response `json:"-"`
// NameAvailable - READ-ONLY; True if the name is available and can be used to create a new API Management service; otherwise false.
NameAvailable *bool `json:"nameAvailable,omitempty"`
// Message - READ-ONLY; If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that <resourceName> is already in use, and direct them to select a different name.
Message *string `json:"message,omitempty"`
// Reason - Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable. Possible values include: 'Valid', 'Invalid', 'AlreadyExists'
Reason NameAvailabilityReason `json:"reason,omitempty"`
}
func (snar ServiceNameAvailabilityResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceNameAvailabilityResult.
ServiceProperties properties of an API Management service resource description.
type ServiceProperties struct {
// PublisherEmail - Publisher email.
PublisherEmail *string `json:"publisherEmail,omitempty"`
// PublisherName - Publisher name.
PublisherName *string `json:"publisherName,omitempty"`
// NotificationSenderEmail - Email address from which the notification will be sent.
NotificationSenderEmail *string `json:"notificationSenderEmail,omitempty"`
// ProvisioningState - READ-ONLY; The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
ProvisioningState *string `json:"provisioningState,omitempty"`
// TargetProvisioningState - READ-ONLY; The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
TargetProvisioningState *string `json:"targetProvisioningState,omitempty"`
// CreatedAtUtc - READ-ONLY; Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
CreatedAtUtc *date.Time `json:"createdAtUtc,omitempty"`
// GatewayURL - READ-ONLY; Gateway URL of the API Management service.
GatewayURL *string `json:"gatewayUrl,omitempty"`
// GatewayRegionalURL - READ-ONLY; Gateway URL of the API Management service in the Default Region.
GatewayRegionalURL *string `json:"gatewayRegionalUrl,omitempty"`
// PortalURL - READ-ONLY; Publisher portal endpoint Url of the API Management service.
PortalURL *string `json:"portalUrl,omitempty"`
// ManagementAPIURL - READ-ONLY; Management API endpoint URL of the API Management service.
ManagementAPIURL *string `json:"managementApiUrl,omitempty"`
// ScmURL - READ-ONLY; SCM endpoint URL of the API Management service.
ScmURL *string `json:"scmUrl,omitempty"`
// HostnameConfigurations - Custom hostname configuration of the API Management service.
HostnameConfigurations *[]HostnameConfiguration `json:"hostnameConfigurations,omitempty"`
// PublicIPAddresses - READ-ONLY; Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU.
PublicIPAddresses *[]string `json:"publicIPAddresses,omitempty"`
// PrivateIPAddresses - READ-ONLY; Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU.
PrivateIPAddresses *[]string `json:"privateIPAddresses,omitempty"`
// VirtualNetworkConfiguration - Virtual network configuration of the API Management service.
VirtualNetworkConfiguration *VirtualNetworkConfiguration `json:"virtualNetworkConfiguration,omitempty"`
// AdditionalLocations - Additional datacenter locations of the API Management service.
AdditionalLocations *[]AdditionalLocation `json:"additionalLocations,omitempty"`
// CustomProperties - Custom properties of the API Management service. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1 and setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.
CustomProperties map[string]*string `json:"customProperties"`
// Certificates - List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
Certificates *[]CertificateConfiguration `json:"certificates,omitempty"`
// VirtualNetworkType - The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. Possible values include: 'VirtualNetworkTypeNone', 'VirtualNetworkTypeExternal', 'VirtualNetworkTypeInternal'
VirtualNetworkType VirtualNetworkType `json:"virtualNetworkType,omitempty"`
}
func (sp ServiceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceProperties.
ServiceResource a single API Management service resource in List or Get response.
type ServiceResource struct {
autorest.Response `json:"-"`
// ServiceProperties - Properties of the API Management service.
*ServiceProperties `json:"properties,omitempty"`
// Sku - SKU properties of the API Management service.
Sku *ServiceSkuProperties `json:"sku,omitempty"`
// Identity - Managed service identity of the Api Management service.
Identity *ServiceIdentity `json:"identity,omitempty"`
// Location - Resource location.
Location *string `json:"location,omitempty"`
// Etag - READ-ONLY; ETag of the resource.
Etag *string `json:"etag,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 is set to Microsoft.ApiManagement.
Type *string `json:"type,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}
func (sr ServiceResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceResource.
func (sr *ServiceResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ServiceResource struct.
ServiceRestoreFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ServiceRestoreFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ServiceClient) (ServiceResource, error)
}
func (future *ServiceRestoreFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ServiceSkuProperties API Management service resource SKU properties.
type ServiceSkuProperties struct {
// Name - Name of the Sku. Possible values include: 'SkuTypeDeveloper', 'SkuTypeStandard', 'SkuTypePremium', 'SkuTypeBasic'
Name SkuType `json:"name,omitempty"`
// Capacity - Capacity of the SKU (number of deployed units of the SKU). The default value is 1.
Capacity *int32 `json:"capacity,omitempty"`
}
ServiceSkusClient is the apiManagement Client
type ServiceSkusClient struct {
BaseClient
}
func NewServiceSkusClient(subscriptionID string) ServiceSkusClient
NewServiceSkusClient creates an instance of the ServiceSkusClient client.
func NewServiceSkusClientWithBaseURI(baseURI string, subscriptionID string) ServiceSkusClient
NewServiceSkusClientWithBaseURI creates an instance of the ServiceSkusClient 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 (client ServiceSkusClient) ListAvailableServiceSkus(ctx context.Context, resourceGroupName string, serviceName string) (result ResourceSkuResultsPage, err error)
ListAvailableServiceSkus gets all available SKU for a given API Management service Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client ServiceSkusClient) ListAvailableServiceSkusComplete(ctx context.Context, resourceGroupName string, serviceName string) (result ResourceSkuResultsIterator, err error)
ListAvailableServiceSkusComplete enumerates all values, automatically crossing page boundaries as required.
func (client ServiceSkusClient) ListAvailableServiceSkusPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
ListAvailableServiceSkusPreparer prepares the ListAvailableServiceSkus request.
func (client ServiceSkusClient) ListAvailableServiceSkusResponder(resp *http.Response) (result ResourceSkuResults, err error)
ListAvailableServiceSkusResponder handles the response to the ListAvailableServiceSkus request. The method always closes the http.Response Body.
func (client ServiceSkusClient) ListAvailableServiceSkusSender(req *http.Request) (*http.Response, error)
ListAvailableServiceSkusSender sends the ListAvailableServiceSkus request. The method will close the http.Response Body if it receives an error.
ServiceUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ServiceUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ServiceClient) (ServiceResource, error)
}
func (future *ServiceUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ServiceUpdateHostnameFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ServiceUpdateHostnameFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ServiceClient) (ServiceResource, error)
}
func (future *ServiceUpdateHostnameFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ServiceUpdateHostnameParameters parameters supplied to the UpdateHostname operation.
type ServiceUpdateHostnameParameters struct {
// Update - Hostnames to create or update.
Update *[]HostnameConfigurationOld `json:"update,omitempty"`
// Delete - Hostnames types to delete.
Delete *[]HostnameType `json:"delete,omitempty"`
}
ServiceUpdateParameters parameter supplied to Update Api Management Service.
type ServiceUpdateParameters struct {
// ServiceUpdateProperties - Properties of the API Management service.
*ServiceUpdateProperties `json:"properties,omitempty"`
// Sku - SKU properties of the API Management service.
Sku *ServiceSkuProperties `json:"sku,omitempty"`
// Identity - Managed service identity of the Api Management service.
Identity *ServiceIdentity `json:"identity,omitempty"`
// Etag - READ-ONLY; ETag of the resource.
Etag *string `json:"etag,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 is set to Microsoft.ApiManagement.
Type *string `json:"type,omitempty"`
// Tags - Resource tags.
Tags map[string]*string `json:"tags"`
}
func (sup ServiceUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceUpdateParameters.
func (sup *ServiceUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ServiceUpdateParameters struct.
ServiceUpdateProperties properties of an API Management service resource description.
type ServiceUpdateProperties struct {
// PublisherEmail - Publisher email.
PublisherEmail *string `json:"publisherEmail,omitempty"`
// PublisherName - Publisher name.
PublisherName *string `json:"publisherName,omitempty"`
// NotificationSenderEmail - Email address from which the notification will be sent.
NotificationSenderEmail *string `json:"notificationSenderEmail,omitempty"`
// ProvisioningState - READ-ONLY; The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
ProvisioningState *string `json:"provisioningState,omitempty"`
// TargetProvisioningState - READ-ONLY; The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
TargetProvisioningState *string `json:"targetProvisioningState,omitempty"`
// CreatedAtUtc - READ-ONLY; Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
CreatedAtUtc *date.Time `json:"createdAtUtc,omitempty"`
// GatewayURL - READ-ONLY; Gateway URL of the API Management service.
GatewayURL *string `json:"gatewayUrl,omitempty"`
// GatewayRegionalURL - READ-ONLY; Gateway URL of the API Management service in the Default Region.
GatewayRegionalURL *string `json:"gatewayRegionalUrl,omitempty"`
// PortalURL - READ-ONLY; Publisher portal endpoint Url of the API Management service.
PortalURL *string `json:"portalUrl,omitempty"`
// ManagementAPIURL - READ-ONLY; Management API endpoint URL of the API Management service.
ManagementAPIURL *string `json:"managementApiUrl,omitempty"`
// ScmURL - READ-ONLY; SCM endpoint URL of the API Management service.
ScmURL *string `json:"scmUrl,omitempty"`
// HostnameConfigurations - Custom hostname configuration of the API Management service.
HostnameConfigurations *[]HostnameConfiguration `json:"hostnameConfigurations,omitempty"`
// PublicIPAddresses - READ-ONLY; Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard and Premium SKU.
PublicIPAddresses *[]string `json:"publicIPAddresses,omitempty"`
// PrivateIPAddresses - READ-ONLY; Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard and Premium SKU.
PrivateIPAddresses *[]string `json:"privateIPAddresses,omitempty"`
// VirtualNetworkConfiguration - Virtual network configuration of the API Management service.
VirtualNetworkConfiguration *VirtualNetworkConfiguration `json:"virtualNetworkConfiguration,omitempty"`
// AdditionalLocations - Additional datacenter locations of the API Management service.
AdditionalLocations *[]AdditionalLocation `json:"additionalLocations,omitempty"`
// CustomProperties - Custom properties of the API Management service. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2). Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1 and setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.
CustomProperties map[string]*string `json:"customProperties"`
// Certificates - List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
Certificates *[]CertificateConfiguration `json:"certificates,omitempty"`
// VirtualNetworkType - The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. Possible values include: 'VirtualNetworkTypeNone', 'VirtualNetworkTypeExternal', 'VirtualNetworkTypeInternal'
VirtualNetworkType VirtualNetworkType `json:"virtualNetworkType,omitempty"`
}
func (sup ServiceUpdateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceUpdateProperties.
ServiceUploadCertificateParameters parameters supplied to the Upload SSL certificate for an API Management service operation.
type ServiceUploadCertificateParameters struct {
// Type - Hostname type. Possible values include: 'Proxy', 'Portal', 'Management', 'Scm'
Type HostnameType `json:"type,omitempty"`
// Certificate - Base64 Encoded certificate.
Certificate *string `json:"certificate,omitempty"`
// CertificatePassword - Certificate password.
CertificatePassword *string `json:"certificate_password,omitempty"`
}
SignInSettingsClient is the apiManagement Client
type SignInSettingsClient struct {
BaseClient
}
func NewSignInSettingsClient(subscriptionID string) SignInSettingsClient
NewSignInSettingsClient creates an instance of the SignInSettingsClient client.
func NewSignInSettingsClientWithBaseURI(baseURI string, subscriptionID string) SignInSettingsClient
NewSignInSettingsClientWithBaseURI creates an instance of the SignInSettingsClient 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 (client SignInSettingsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSigninSettings) (result PortalSigninSettings, err error)
CreateOrUpdate create or Update Sign-In settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - create or update parameters.
func (client SignInSettingsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSigninSettings) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client SignInSettingsClient) CreateOrUpdateResponder(resp *http.Response) (result PortalSigninSettings, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client SignInSettingsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client SignInSettingsClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result PortalSigninSettings, err error)
Get get Sign-In settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client SignInSettingsClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the SignInSettings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client SignInSettingsClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client SignInSettingsClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client SignInSettingsClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client SignInSettingsClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client SignInSettingsClient) GetResponder(resp *http.Response) (result PortalSigninSettings, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client SignInSettingsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client SignInSettingsClient) Update(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSigninSettings, ifMatch string) (result autorest.Response, err error)
Update update Sign-In settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - update Sign-In settings. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client SignInSettingsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSigninSettings, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client SignInSettingsClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client SignInSettingsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
SignUpSettingsClient is the apiManagement Client
type SignUpSettingsClient struct {
BaseClient
}
func NewSignUpSettingsClient(subscriptionID string) SignUpSettingsClient
NewSignUpSettingsClient creates an instance of the SignUpSettingsClient client.
func NewSignUpSettingsClientWithBaseURI(baseURI string, subscriptionID string) SignUpSettingsClient
NewSignUpSettingsClientWithBaseURI creates an instance of the SignUpSettingsClient 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 (client SignUpSettingsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSignupSettings) (result PortalSignupSettings, err error)
CreateOrUpdate create or Update Sign-Up settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - create or update parameters.
func (client SignUpSettingsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSignupSettings) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client SignUpSettingsClient) CreateOrUpdateResponder(resp *http.Response) (result PortalSignupSettings, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client SignUpSettingsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client SignUpSettingsClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result PortalSignupSettings, err error)
Get get Sign-Up settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client SignUpSettingsClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the SignUpSettings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client SignUpSettingsClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client SignUpSettingsClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client SignUpSettingsClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client SignUpSettingsClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client SignUpSettingsClient) GetResponder(resp *http.Response) (result PortalSignupSettings, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client SignUpSettingsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client SignUpSettingsClient) Update(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSignupSettings, ifMatch string) (result autorest.Response, err error)
Update update Sign-Up settings. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - update Sign-Up settings. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client SignUpSettingsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters PortalSignupSettings, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client SignUpSettingsClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client SignUpSettingsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
SkuType enumerates the values for sku type.
type SkuType string
const (
// SkuTypeBasic Basic SKU of Api Management.
SkuTypeBasic SkuType = "Basic"
// SkuTypeDeveloper Developer SKU of Api Management.
SkuTypeDeveloper SkuType = "Developer"
// SkuTypePremium Premium SKU of Api Management.
SkuTypePremium SkuType = "Premium"
// SkuTypeStandard Standard SKU of Api Management.
SkuTypeStandard SkuType = "Standard"
)
func PossibleSkuTypeValues() []SkuType
PossibleSkuTypeValues returns an array of possible values for the SkuType const type.
SoapAPIType enumerates the values for soap api type.
type SoapAPIType string
const (
// SoapPassThrough Imports the Soap API having a SOAP front end.
SoapPassThrough SoapAPIType = "soap"
// SoapToRest Imports a SOAP API having a RESTful front end.
SoapToRest SoapAPIType = "http"
)
func PossibleSoapAPITypeValues() []SoapAPIType
PossibleSoapAPITypeValues returns an array of possible values for the SoapAPIType const type.
State enumerates the values for state.
type State string
const (
// Closed The issue was closed.
Closed State = "closed"
// Open The issue is opened.
Open State = "open"
// Proposed The issue is proposed.
Proposed State = "proposed"
// Removed The issue was removed.
Removed State = "removed"
// Resolved The issue is now resolved.
Resolved State = "resolved"
)
func PossibleStateValues() []State
PossibleStateValues returns an array of possible values for the State const type.
StoreName enumerates the values for store name.
type StoreName string
const (
// CertificateAuthority ...
CertificateAuthority StoreName = "CertificateAuthority"
// Root ...
Root StoreName = "Root"
)
func PossibleStoreNameValues() []StoreName
PossibleStoreNameValues returns an array of possible values for the StoreName const type.
SubscriptionClient is the apiManagement Client
type SubscriptionClient struct {
BaseClient
}
func NewSubscriptionClient(subscriptionID string) SubscriptionClient
NewSubscriptionClient creates an instance of the SubscriptionClient client.
func NewSubscriptionClientWithBaseURI(baseURI string, subscriptionID string) SubscriptionClient
NewSubscriptionClientWithBaseURI creates an instance of the SubscriptionClient 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 (client SubscriptionClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, sid string, parameters SubscriptionCreateParameters, notify *bool, ifMatch string) (result SubscriptionContract, err error)
CreateOrUpdate creates or updates the subscription of specified user to the specified product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. sid - subscription entity Identifier. The entity represents the association between a user and a product in API Management. parameters - create parameters. notify - notify change in Subscription State. - If false, do not send any email notification for change of state of subscription - If true, send email notification of change of state of subscription ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client SubscriptionClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string, parameters SubscriptionCreateParameters, notify *bool, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client SubscriptionClient) CreateOrUpdateResponder(resp *http.Response) (result SubscriptionContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client SubscriptionClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client SubscriptionClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, sid string, ifMatch string) (result autorest.Response, err error)
Delete deletes the specified subscription. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. sid - subscription entity Identifier. The entity represents the association between a user and a product in API Management. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client SubscriptionClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client SubscriptionClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client SubscriptionClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client SubscriptionClient) Get(ctx context.Context, resourceGroupName string, serviceName string, sid string) (result SubscriptionContract, err error)
Get gets the specified Subscription entity. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. sid - subscription entity Identifier. The entity represents the association between a user and a product in API Management.
func (client SubscriptionClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, sid string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the apimanagement subscription specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. sid - subscription entity Identifier. The entity represents the association between a user and a product in API Management.
func (client SubscriptionClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client SubscriptionClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client SubscriptionClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client SubscriptionClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client SubscriptionClient) GetResponder(resp *http.Response) (result SubscriptionContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client SubscriptionClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client SubscriptionClient) List(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result SubscriptionCollectionPage, err error)
List lists all subscriptions of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |--------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | top - number of records to return. skip - number of records to skip.
func (client SubscriptionClient) ListComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result SubscriptionCollectionIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client SubscriptionClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListPreparer prepares the List request.
func (client SubscriptionClient) ListResponder(resp *http.Response) (result SubscriptionCollection, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client SubscriptionClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client SubscriptionClient) RegeneratePrimaryKey(ctx context.Context, resourceGroupName string, serviceName string, sid string) (result autorest.Response, err error)
RegeneratePrimaryKey regenerates primary key of existing subscription of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. sid - subscription entity Identifier. The entity represents the association between a user and a product in API Management.
func (client SubscriptionClient) RegeneratePrimaryKeyPreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string) (*http.Request, error)
RegeneratePrimaryKeyPreparer prepares the RegeneratePrimaryKey request.
func (client SubscriptionClient) RegeneratePrimaryKeyResponder(resp *http.Response) (result autorest.Response, err error)
RegeneratePrimaryKeyResponder handles the response to the RegeneratePrimaryKey request. The method always closes the http.Response Body.
func (client SubscriptionClient) RegeneratePrimaryKeySender(req *http.Request) (*http.Response, error)
RegeneratePrimaryKeySender sends the RegeneratePrimaryKey request. The method will close the http.Response Body if it receives an error.
func (client SubscriptionClient) RegenerateSecondaryKey(ctx context.Context, resourceGroupName string, serviceName string, sid string) (result autorest.Response, err error)
RegenerateSecondaryKey regenerates secondary key of existing subscription of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. sid - subscription entity Identifier. The entity represents the association between a user and a product in API Management.
func (client SubscriptionClient) RegenerateSecondaryKeyPreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string) (*http.Request, error)
RegenerateSecondaryKeyPreparer prepares the RegenerateSecondaryKey request.
func (client SubscriptionClient) RegenerateSecondaryKeyResponder(resp *http.Response) (result autorest.Response, err error)
RegenerateSecondaryKeyResponder handles the response to the RegenerateSecondaryKey request. The method always closes the http.Response Body.
func (client SubscriptionClient) RegenerateSecondaryKeySender(req *http.Request) (*http.Response, error)
RegenerateSecondaryKeySender sends the RegenerateSecondaryKey request. The method will close the http.Response Body if it receives an error.
func (client SubscriptionClient) Update(ctx context.Context, resourceGroupName string, serviceName string, sid string, parameters SubscriptionUpdateParameters, ifMatch string, notify *bool) (result autorest.Response, err error)
Update updates the details of a subscription specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. sid - subscription entity Identifier. The entity represents the association between a user and a product in API Management. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. notify - notify change in Subscription State. - If false, do not send any email notification for change of state of subscription - If true, send email notification of change of state of subscription
func (client SubscriptionClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, sid string, parameters SubscriptionUpdateParameters, ifMatch string, notify *bool) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client SubscriptionClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client SubscriptionClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
SubscriptionCollection paged Subscriptions list representation.
type SubscriptionCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]SubscriptionContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (sc SubscriptionCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
SubscriptionCollectionIterator provides access to a complete listing of SubscriptionContract values.
type SubscriptionCollectionIterator struct {
// contains filtered or unexported fields
}
func NewSubscriptionCollectionIterator(page SubscriptionCollectionPage) SubscriptionCollectionIterator
Creates a new instance of the SubscriptionCollectionIterator type.
func (iter *SubscriptionCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *SubscriptionCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter SubscriptionCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SubscriptionCollectionIterator) Response() SubscriptionCollection
Response returns the raw server response from the last page request.
func (iter SubscriptionCollectionIterator) Value() SubscriptionContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
SubscriptionCollectionPage contains a page of SubscriptionContract values.
type SubscriptionCollectionPage struct {
// contains filtered or unexported fields
}
func NewSubscriptionCollectionPage(cur SubscriptionCollection, getNextPage func(context.Context, SubscriptionCollection) (SubscriptionCollection, error)) SubscriptionCollectionPage
Creates a new instance of the SubscriptionCollectionPage type.
func (page *SubscriptionCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *SubscriptionCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page SubscriptionCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SubscriptionCollectionPage) Response() SubscriptionCollection
Response returns the raw server response from the last page request.
func (page SubscriptionCollectionPage) Values() []SubscriptionContract
Values returns the slice of values for the current page or nil if there are no values.
SubscriptionContract subscription details.
type SubscriptionContract struct {
autorest.Response `json:"-"`
// SubscriptionContractProperties - Subscription contract properties.
*SubscriptionContractProperties `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"`
}
func (sc SubscriptionContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SubscriptionContract.
func (sc *SubscriptionContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SubscriptionContract struct.
SubscriptionContractProperties subscription details.
type SubscriptionContractProperties struct {
// UserID - The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier.
UserID *string `json:"userId,omitempty"`
// ProductID - The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier.
ProductID *string `json:"productId,omitempty"`
// DisplayName - The name of the subscription, or null if the subscription has no name.
DisplayName *string `json:"displayName,omitempty"`
// State - Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. Possible values include: 'Suspended', 'Active', 'Expired', 'Submitted', 'Rejected', 'Cancelled'
State SubscriptionState `json:"state,omitempty"`
// CreatedDate - READ-ONLY; Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
CreatedDate *date.Time `json:"createdDate,omitempty"`
// StartDate - Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
StartDate *date.Time `json:"startDate,omitempty"`
// ExpirationDate - Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
ExpirationDate *date.Time `json:"expirationDate,omitempty"`
// EndDate - Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
EndDate *date.Time `json:"endDate,omitempty"`
// NotificationDate - Upcoming subscription expiration notification date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
NotificationDate *date.Time `json:"notificationDate,omitempty"`
// PrimaryKey - Subscription primary key.
PrimaryKey *string `json:"primaryKey,omitempty"`
// SecondaryKey - Subscription secondary key.
SecondaryKey *string `json:"secondaryKey,omitempty"`
// StateComment - Optional subscription comment added by an administrator.
StateComment *string `json:"stateComment,omitempty"`
}
func (scp SubscriptionContractProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SubscriptionContractProperties.
SubscriptionCreateParameterProperties parameters supplied to the Create subscription operation.
type SubscriptionCreateParameterProperties struct {
// UserID - User (user id path) for whom subscription is being created in form /users/{uid}
UserID *string `json:"userId,omitempty"`
// ProductID - Product (product id path) for which subscription is being created in form /products/{productId}
ProductID *string `json:"productId,omitempty"`
// DisplayName - Subscription name.
DisplayName *string `json:"displayName,omitempty"`
// PrimaryKey - Primary subscription key. If not specified during request key will be generated automatically.
PrimaryKey *string `json:"primaryKey,omitempty"`
// SecondaryKey - Secondary subscription key. If not specified during request key will be generated automatically.
SecondaryKey *string `json:"secondaryKey,omitempty"`
// State - Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. Possible values include: 'Suspended', 'Active', 'Expired', 'Submitted', 'Rejected', 'Cancelled'
State SubscriptionState `json:"state,omitempty"`
}
SubscriptionCreateParameters subscription create details.
type SubscriptionCreateParameters struct {
// SubscriptionCreateParameterProperties - Subscription contract properties.
*SubscriptionCreateParameterProperties `json:"properties,omitempty"`
}
func (scp SubscriptionCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SubscriptionCreateParameters.
func (scp *SubscriptionCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SubscriptionCreateParameters struct.
SubscriptionKeyParameterNamesContract subscription key parameter names details.
type SubscriptionKeyParameterNamesContract struct {
// Header - Subscription key header name.
Header *string `json:"header,omitempty"`
// Query - Subscription key query string parameter name.
Query *string `json:"query,omitempty"`
}
SubscriptionState enumerates the values for subscription state.
type SubscriptionState string
const (
// Active ...
Active SubscriptionState = "active"
// Cancelled ...
Cancelled SubscriptionState = "cancelled"
// Expired ...
Expired SubscriptionState = "expired"
// Rejected ...
Rejected SubscriptionState = "rejected"
// Submitted ...
Submitted SubscriptionState = "submitted"
// Suspended ...
Suspended SubscriptionState = "suspended"
)
func PossibleSubscriptionStateValues() []SubscriptionState
PossibleSubscriptionStateValues returns an array of possible values for the SubscriptionState const type.
SubscriptionUpdateParameterProperties parameters supplied to the Update subscription operation.
type SubscriptionUpdateParameterProperties struct {
// UserID - User identifier path: /users/{uid}
UserID *string `json:"userId,omitempty"`
// ProductID - Product identifier path: /products/{productId}
ProductID *string `json:"productId,omitempty"`
// ExpirationDate - Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
ExpirationDate *date.Time `json:"expirationDate,omitempty"`
// DisplayName - Subscription name.
DisplayName *string `json:"displayName,omitempty"`
// PrimaryKey - Primary subscription key.
PrimaryKey *string `json:"primaryKey,omitempty"`
// SecondaryKey - Secondary subscription key.
SecondaryKey *string `json:"secondaryKey,omitempty"`
// State - Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. Possible values include: 'Suspended', 'Active', 'Expired', 'Submitted', 'Rejected', 'Cancelled'
State SubscriptionState `json:"state,omitempty"`
// StateComment - Comments describing subscription state change by the administrator.
StateComment *string `json:"stateComment,omitempty"`
}
SubscriptionUpdateParameters subscription update details.
type SubscriptionUpdateParameters struct {
// SubscriptionUpdateParameterProperties - Subscription Update contract properties.
*SubscriptionUpdateParameterProperties `json:"properties,omitempty"`
}
func (sup SubscriptionUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SubscriptionUpdateParameters.
func (sup *SubscriptionUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SubscriptionUpdateParameters struct.
SubscriptionsDelegationSettingsProperties subscriptions delegation settings properties.
type SubscriptionsDelegationSettingsProperties struct {
// Enabled - Enable or disable delegation for subscriptions.
Enabled *bool `json:"enabled,omitempty"`
}
TagClient is the apiManagement Client
type TagClient struct {
BaseClient
}
func NewTagClient(subscriptionID string) TagClient
NewTagClient creates an instance of the TagClient client.
func NewTagClientWithBaseURI(baseURI string, subscriptionID string) TagClient
NewTagClientWithBaseURI creates an instance of the TagClient 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 (client TagClient) AssignToAPI(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, ifMatch string) (result TagContract, err error)
AssignToAPI assign tag to the Api. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client TagClient) AssignToAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, ifMatch string) (*http.Request, error)
AssignToAPIPreparer prepares the AssignToAPI request.
func (client TagClient) AssignToAPIResponder(resp *http.Response) (result TagContract, err error)
AssignToAPIResponder handles the response to the AssignToAPI request. The method always closes the http.Response Body.
func (client TagClient) AssignToAPISender(req *http.Request) (*http.Response, error)
AssignToAPISender sends the AssignToAPI request. The method will close the http.Response Body if it receives an error.
func (client TagClient) AssignToOperation(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string, ifMatch string) (result TagContract, err error)
AssignToOperation assign tag to the Operation. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client TagClient) AssignToOperationPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string, ifMatch string) (*http.Request, error)
AssignToOperationPreparer prepares the AssignToOperation request.
func (client TagClient) AssignToOperationResponder(resp *http.Response) (result TagContract, err error)
AssignToOperationResponder handles the response to the AssignToOperation request. The method always closes the http.Response Body.
func (client TagClient) AssignToOperationSender(req *http.Request) (*http.Response, error)
AssignToOperationSender sends the AssignToOperation request. The method will close the http.Response Body if it receives an error.
func (client TagClient) AssignToProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string, ifMatch string) (result TagContract, err error)
AssignToProduct assign tag to the Product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client TagClient) AssignToProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string, ifMatch string) (*http.Request, error)
AssignToProductPreparer prepares the AssignToProduct request.
func (client TagClient) AssignToProductResponder(resp *http.Response) (result TagContract, err error)
AssignToProductResponder handles the response to the AssignToProduct request. The method always closes the http.Response Body.
func (client TagClient) AssignToProductSender(req *http.Request) (*http.Response, error)
AssignToProductSender sends the AssignToProduct request. The method will close the http.Response Body if it receives an error.
func (client TagClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, tagID string, parameters TagCreateUpdateParameters) (result TagContract, err error)
CreateOrUpdate creates a tag. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. tagID - tag identifier. Must be unique in the current API Management service instance. parameters - create parameters.
func (client TagClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, tagID string, parameters TagCreateUpdateParameters) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client TagClient) CreateOrUpdateResponder(resp *http.Response) (result TagContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client TagClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client TagClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, tagID string, ifMatch string) (result autorest.Response, err error)
Delete deletes specific tag of the API Management service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client TagClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, tagID string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client TagClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client TagClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client TagClient) DetachFromAPI(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, ifMatch string) (result autorest.Response, err error)
DetachFromAPI detach the tag from the Api. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client TagClient) DetachFromAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, ifMatch string) (*http.Request, error)
DetachFromAPIPreparer prepares the DetachFromAPI request.
func (client TagClient) DetachFromAPIResponder(resp *http.Response) (result autorest.Response, err error)
DetachFromAPIResponder handles the response to the DetachFromAPI request. The method always closes the http.Response Body.
func (client TagClient) DetachFromAPISender(req *http.Request) (*http.Response, error)
DetachFromAPISender sends the DetachFromAPI request. The method will close the http.Response Body if it receives an error.
func (client TagClient) DetachFromOperation(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string, ifMatch string) (result autorest.Response, err error)
DetachFromOperation detach the tag from the Operation. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client TagClient) DetachFromOperationPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string, ifMatch string) (*http.Request, error)
DetachFromOperationPreparer prepares the DetachFromOperation request.
func (client TagClient) DetachFromOperationResponder(resp *http.Response) (result autorest.Response, err error)
DetachFromOperationResponder handles the response to the DetachFromOperation request. The method always closes the http.Response Body.
func (client TagClient) DetachFromOperationSender(req *http.Request) (*http.Response, error)
DetachFromOperationSender sends the DetachFromOperation request. The method will close the http.Response Body if it receives an error.
func (client TagClient) DetachFromProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string, ifMatch string) (result autorest.Response, err error)
DetachFromProduct detach the tag from the Product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client TagClient) DetachFromProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string, ifMatch string) (*http.Request, error)
DetachFromProductPreparer prepares the DetachFromProduct request.
func (client TagClient) DetachFromProductResponder(resp *http.Response) (result autorest.Response, err error)
DetachFromProductResponder handles the response to the DetachFromProduct request. The method always closes the http.Response Body.
func (client TagClient) DetachFromProductSender(req *http.Request) (*http.Response, error)
DetachFromProductSender sends the DetachFromProduct request. The method will close the http.Response Body if it receives an error.
func (client TagClient) Get(ctx context.Context, resourceGroupName string, serviceName string, tagID string) (result TagContract, err error)
Get gets the details of the tag specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. tagID - tag identifier. Must be unique in the current API Management service instance.
func (client TagClient) GetByAPI(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (result TagContract, err error)
GetByAPI get tag associated with the API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagID - tag identifier. Must be unique in the current API Management service instance.
func (client TagClient) GetByAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (*http.Request, error)
GetByAPIPreparer prepares the GetByAPI request.
func (client TagClient) GetByAPIResponder(resp *http.Response) (result TagContract, err error)
GetByAPIResponder handles the response to the GetByAPI request. The method always closes the http.Response Body.
func (client TagClient) GetByAPISender(req *http.Request) (*http.Response, error)
GetByAPISender sends the GetByAPI request. The method will close the http.Response Body if it receives an error.
func (client TagClient) GetByOperation(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string) (result TagContract, err error)
GetByOperation get tag associated with the Operation. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance.
func (client TagClient) GetByOperationPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string) (*http.Request, error)
GetByOperationPreparer prepares the GetByOperation request.
func (client TagClient) GetByOperationResponder(resp *http.Response) (result TagContract, err error)
GetByOperationResponder handles the response to the GetByOperation request. The method always closes the http.Response Body.
func (client TagClient) GetByOperationSender(req *http.Request) (*http.Response, error)
GetByOperationSender sends the GetByOperation request. The method will close the http.Response Body if it receives an error.
func (client TagClient) GetByProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string) (result TagContract, err error)
GetByProduct get tag associated with the Product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance.
func (client TagClient) GetByProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string) (*http.Request, error)
GetByProductPreparer prepares the GetByProduct request.
func (client TagClient) GetByProductResponder(resp *http.Response) (result TagContract, err error)
GetByProductResponder handles the response to the GetByProduct request. The method always closes the http.Response Body.
func (client TagClient) GetByProductSender(req *http.Request) (*http.Response, error)
GetByProductSender sends the GetByProduct request. The method will close the http.Response Body if it receives an error.
func (client TagClient) GetEntityState(ctx context.Context, resourceGroupName string, serviceName string, tagID string) (result autorest.Response, err error)
GetEntityState gets the entity state version of the tag specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. tagID - tag identifier. Must be unique in the current API Management service instance.
func (client TagClient) GetEntityStateByAPI(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (result autorest.Response, err error)
GetEntityStateByAPI gets the entity state version of the tag specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagID - tag identifier. Must be unique in the current API Management service instance.
func (client TagClient) GetEntityStateByAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (*http.Request, error)
GetEntityStateByAPIPreparer prepares the GetEntityStateByAPI request.
func (client TagClient) GetEntityStateByAPIResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityStateByAPIResponder handles the response to the GetEntityStateByAPI request. The method always closes the http.Response Body.
func (client TagClient) GetEntityStateByAPISender(req *http.Request) (*http.Response, error)
GetEntityStateByAPISender sends the GetEntityStateByAPI request. The method will close the http.Response Body if it receives an error.
func (client TagClient) GetEntityStateByOperation(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string) (result autorest.Response, err error)
GetEntityStateByOperation gets the entity state version of the tag specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance.
func (client TagClient) GetEntityStateByOperationPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, tagID string) (*http.Request, error)
GetEntityStateByOperationPreparer prepares the GetEntityStateByOperation request.
func (client TagClient) GetEntityStateByOperationResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityStateByOperationResponder handles the response to the GetEntityStateByOperation request. The method always closes the http.Response Body.
func (client TagClient) GetEntityStateByOperationSender(req *http.Request) (*http.Response, error)
GetEntityStateByOperationSender sends the GetEntityStateByOperation request. The method will close the http.Response Body if it receives an error.
func (client TagClient) GetEntityStateByProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string) (result autorest.Response, err error)
GetEntityStateByProduct gets the entity state version of the tag specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. tagID - tag identifier. Must be unique in the current API Management service instance.
func (client TagClient) GetEntityStateByProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, tagID string) (*http.Request, error)
GetEntityStateByProductPreparer prepares the GetEntityStateByProduct request.
func (client TagClient) GetEntityStateByProductResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityStateByProductResponder handles the response to the GetEntityStateByProduct request. The method always closes the http.Response Body.
func (client TagClient) GetEntityStateByProductSender(req *http.Request) (*http.Response, error)
GetEntityStateByProductSender sends the GetEntityStateByProduct request. The method will close the http.Response Body if it receives an error.
func (client TagClient) GetEntityStatePreparer(ctx context.Context, resourceGroupName string, serviceName string, tagID string) (*http.Request, error)
GetEntityStatePreparer prepares the GetEntityState request.
func (client TagClient) GetEntityStateResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityStateResponder handles the response to the GetEntityState request. The method always closes the http.Response Body.
func (client TagClient) GetEntityStateSender(req *http.Request) (*http.Response, error)
GetEntityStateSender sends the GetEntityState request. The method will close the http.Response Body if it receives an error.
func (client TagClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, tagID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client TagClient) GetResponder(resp *http.Response) (result TagContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client TagClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client TagClient) ListByAPI(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result TagCollectionPage, err error)
ListByAPI lists all Tags associated with the API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client TagClient) ListByAPIComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result TagCollectionIterator, err error)
ListByAPIComplete enumerates all values, automatically crossing page boundaries as required.
func (client TagClient) ListByAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByAPIPreparer prepares the ListByAPI request.
func (client TagClient) ListByAPIResponder(resp *http.Response) (result TagCollection, err error)
ListByAPIResponder handles the response to the ListByAPI request. The method always closes the http.Response Body.
func (client TagClient) ListByAPISender(req *http.Request) (*http.Response, error)
ListByAPISender sends the ListByAPI request. The method will close the http.Response Body if it receives an error.
func (client TagClient) ListByOperation(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, filter string, top *int32, skip *int32) (result TagCollectionPage, err error)
ListByOperation lists all Tags associated with the Operation. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. operationID - operation identifier within an API. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client TagClient) ListByOperationComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, filter string, top *int32, skip *int32) (result TagCollectionIterator, err error)
ListByOperationComplete enumerates all values, automatically crossing page boundaries as required.
func (client TagClient) ListByOperationPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, operationID string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByOperationPreparer prepares the ListByOperation request.
func (client TagClient) ListByOperationResponder(resp *http.Response) (result TagCollection, err error)
ListByOperationResponder handles the response to the ListByOperation request. The method always closes the http.Response Body.
func (client TagClient) ListByOperationSender(req *http.Request) (*http.Response, error)
ListByOperationSender sends the ListByOperation request. The method will close the http.Response Body if it receives an error.
func (client TagClient) ListByProduct(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result TagCollectionPage, err error)
ListByProduct lists all Tags associated with the Product. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. productID - product identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client TagClient) ListByProductComplete(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (result TagCollectionIterator, err error)
ListByProductComplete enumerates all values, automatically crossing page boundaries as required.
func (client TagClient) ListByProductPreparer(ctx context.Context, resourceGroupName string, serviceName string, productID string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByProductPreparer prepares the ListByProduct request.
func (client TagClient) ListByProductResponder(resp *http.Response) (result TagCollection, err error)
ListByProductResponder handles the response to the ListByProduct request. The method always closes the http.Response Body.
func (client TagClient) ListByProductSender(req *http.Request) (*http.Response, error)
ListByProductSender sends the ListByProduct request. The method will close the http.Response Body if it receives an error.
func (client TagClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result TagCollectionPage, err error)
ListByService lists a collection of tags defined within a service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client TagClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result TagCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client TagClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client TagClient) ListByServiceResponder(resp *http.Response) (result TagCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client TagClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
func (client TagClient) Update(ctx context.Context, resourceGroupName string, serviceName string, tagID string, parameters TagCreateUpdateParameters, ifMatch string) (result autorest.Response, err error)
Update updates the details of the tag specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. tagID - tag identifier. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client TagClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, tagID string, parameters TagCreateUpdateParameters, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client TagClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client TagClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
TagCollection paged Tag list representation.
type TagCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]TagContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (tc TagCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
TagCollectionIterator provides access to a complete listing of TagContract values.
type TagCollectionIterator struct {
// contains filtered or unexported fields
}
func NewTagCollectionIterator(page TagCollectionPage) TagCollectionIterator
Creates a new instance of the TagCollectionIterator type.
func (iter *TagCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *TagCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter TagCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter TagCollectionIterator) Response() TagCollection
Response returns the raw server response from the last page request.
func (iter TagCollectionIterator) Value() TagContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
TagCollectionPage contains a page of TagContract values.
type TagCollectionPage struct {
// contains filtered or unexported fields
}
func NewTagCollectionPage(cur TagCollection, getNextPage func(context.Context, TagCollection) (TagCollection, error)) TagCollectionPage
Creates a new instance of the TagCollectionPage type.
func (page *TagCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *TagCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page TagCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page TagCollectionPage) Response() TagCollection
Response returns the raw server response from the last page request.
func (page TagCollectionPage) Values() []TagContract
Values returns the slice of values for the current page or nil if there are no values.
TagContract tag Contract details.
type TagContract struct {
autorest.Response `json:"-"`
// TagContractProperties - Tag entity contract properties.
*TagContractProperties `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"`
}
func (tc TagContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TagContract.
func (tc *TagContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for TagContract struct.
TagContractProperties tag contract Properties.
type TagContractProperties struct {
// DisplayName - Tag name.
DisplayName *string `json:"displayName,omitempty"`
}
TagCreateUpdateParameters parameters supplied to Create/Update Tag operations.
type TagCreateUpdateParameters struct {
// TagContractProperties - Properties supplied to Create Tag operation.
*TagContractProperties `json:"properties,omitempty"`
}
func (tcup TagCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TagCreateUpdateParameters.
func (tcup *TagCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for TagCreateUpdateParameters struct.
TagDescriptionBaseProperties parameters supplied to the Create TagDescription operation.
type TagDescriptionBaseProperties struct {
// Description - Description of the Tag.
Description *string `json:"description,omitempty"`
// ExternalDocsURL - Absolute URL of external resources describing the tag.
ExternalDocsURL *string `json:"externalDocsUrl,omitempty"`
// ExternalDocsDescription - Description of the external resources describing the tag.
ExternalDocsDescription *string `json:"externalDocsDescription,omitempty"`
}
TagDescriptionClient is the apiManagement Client
type TagDescriptionClient struct {
BaseClient
}
func NewTagDescriptionClient(subscriptionID string) TagDescriptionClient
NewTagDescriptionClient creates an instance of the TagDescriptionClient client.
func NewTagDescriptionClientWithBaseURI(baseURI string, subscriptionID string) TagDescriptionClient
NewTagDescriptionClientWithBaseURI creates an instance of the TagDescriptionClient 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 (client TagDescriptionClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, parameters TagDescriptionCreateParameters, ifMatch string) (result TagDescriptionContract, err error)
CreateOrUpdate create/Update tag 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. tagID - tag identifier. Must be unique in the current API Management service instance. parameters - create parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client TagDescriptionClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, parameters TagDescriptionCreateParameters, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client TagDescriptionClient) CreateOrUpdateResponder(resp *http.Response) (result TagDescriptionContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client TagDescriptionClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client TagDescriptionClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, ifMatch string) (result autorest.Response, err error)
Delete delete tag description for the Api. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagID - tag identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client TagDescriptionClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string, ifMatch string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client TagDescriptionClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client TagDescriptionClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client TagDescriptionClient) Get(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (result TagDescriptionContract, err error)
Get get tag associated with the API. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagID - tag identifier. Must be unique in the current API Management service instance.
func (client TagDescriptionClient) GetEntityState(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (result autorest.Response, err error)
GetEntityState gets the entity state version of the tag specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. tagID - tag identifier. Must be unique in the current API Management service instance.
func (client TagDescriptionClient) GetEntityStatePreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (*http.Request, error)
GetEntityStatePreparer prepares the GetEntityState request.
func (client TagDescriptionClient) GetEntityStateResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityStateResponder handles the response to the GetEntityState request. The method always closes the http.Response Body.
func (client TagDescriptionClient) GetEntityStateSender(req *http.Request) (*http.Response, error)
GetEntityStateSender sends the GetEntityState request. The method will close the http.Response Body if it receives an error.
func (client TagDescriptionClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, tagID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client TagDescriptionClient) GetResponder(resp *http.Response) (result TagDescriptionContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client TagDescriptionClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client TagDescriptionClient) ListByAPI(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result TagDescriptionCollectionPage, err error)
ListByAPI lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. apiid - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client TagDescriptionClient) ListByAPIComplete(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (result TagDescriptionCollectionIterator, err error)
ListByAPIComplete enumerates all values, automatically crossing page boundaries as required.
func (client TagDescriptionClient) ListByAPIPreparer(ctx context.Context, resourceGroupName string, serviceName string, apiid string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByAPIPreparer prepares the ListByAPI request.
func (client TagDescriptionClient) ListByAPIResponder(resp *http.Response) (result TagDescriptionCollection, err error)
ListByAPIResponder handles the response to the ListByAPI request. The method always closes the http.Response Body.
func (client TagDescriptionClient) ListByAPISender(req *http.Request) (*http.Response, error)
ListByAPISender sends the ListByAPI request. The method will close the http.Response Body if it receives an error.
TagDescriptionCollection paged TagDescription list representation.
type TagDescriptionCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]TagDescriptionContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (tdc TagDescriptionCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
TagDescriptionCollectionIterator provides access to a complete listing of TagDescriptionContract values.
type TagDescriptionCollectionIterator struct {
// contains filtered or unexported fields
}
func NewTagDescriptionCollectionIterator(page TagDescriptionCollectionPage) TagDescriptionCollectionIterator
Creates a new instance of the TagDescriptionCollectionIterator type.
func (iter *TagDescriptionCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *TagDescriptionCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter TagDescriptionCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter TagDescriptionCollectionIterator) Response() TagDescriptionCollection
Response returns the raw server response from the last page request.
func (iter TagDescriptionCollectionIterator) Value() TagDescriptionContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
TagDescriptionCollectionPage contains a page of TagDescriptionContract values.
type TagDescriptionCollectionPage struct {
// contains filtered or unexported fields
}
func NewTagDescriptionCollectionPage(cur TagDescriptionCollection, getNextPage func(context.Context, TagDescriptionCollection) (TagDescriptionCollection, error)) TagDescriptionCollectionPage
Creates a new instance of the TagDescriptionCollectionPage type.
func (page *TagDescriptionCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *TagDescriptionCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page TagDescriptionCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page TagDescriptionCollectionPage) Response() TagDescriptionCollection
Response returns the raw server response from the last page request.
func (page TagDescriptionCollectionPage) Values() []TagDescriptionContract
Values returns the slice of values for the current page or nil if there are no values.
TagDescriptionContract contract details.
type TagDescriptionContract struct {
autorest.Response `json:"-"`
// TagDescriptionContractProperties - TagDescription entity contract properties.
*TagDescriptionContractProperties `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"`
}
func (tdc TagDescriptionContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TagDescriptionContract.
func (tdc *TagDescriptionContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for TagDescriptionContract struct.
TagDescriptionContractProperties tagDescription contract Properties.
type TagDescriptionContractProperties struct {
// DisplayName - Tag name.
DisplayName *string `json:"displayName,omitempty"`
// Description - Description of the Tag.
Description *string `json:"description,omitempty"`
// ExternalDocsURL - Absolute URL of external resources describing the tag.
ExternalDocsURL *string `json:"externalDocsUrl,omitempty"`
// ExternalDocsDescription - Description of the external resources describing the tag.
ExternalDocsDescription *string `json:"externalDocsDescription,omitempty"`
}
TagDescriptionCreateParameters parameters supplied to the Create TagDescription operation.
type TagDescriptionCreateParameters struct {
// TagDescriptionBaseProperties - Properties supplied to Create TagDescription operation.
*TagDescriptionBaseProperties `json:"properties,omitempty"`
}
func (tdcp TagDescriptionCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TagDescriptionCreateParameters.
func (tdcp *TagDescriptionCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for TagDescriptionCreateParameters struct.
TagResourceClient is the apiManagement Client
type TagResourceClient struct {
BaseClient
}
func NewTagResourceClient(subscriptionID string) TagResourceClient
NewTagResourceClient creates an instance of the TagResourceClient client.
func NewTagResourceClientWithBaseURI(baseURI string, subscriptionID string) TagResourceClient
NewTagResourceClientWithBaseURI creates an instance of the TagResourceClient 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 (client TagResourceClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result TagResourceCollectionPage, err error)
ListByService lists a collection of resources associated with tags. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | aid | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | terms | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | isCurrent | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client TagResourceClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result TagResourceCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client TagResourceClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client TagResourceClient) ListByServiceResponder(resp *http.Response) (result TagResourceCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client TagResourceClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
TagResourceCollection paged Tag list representation.
type TagResourceCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]TagResourceContract `json:"value,omitempty"`
// Count - Total record count number across all pages.
Count *int64 `json:"count,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (trc TagResourceCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
TagResourceCollectionIterator provides access to a complete listing of TagResourceContract values.
type TagResourceCollectionIterator struct {
// contains filtered or unexported fields
}
func NewTagResourceCollectionIterator(page TagResourceCollectionPage) TagResourceCollectionIterator
Creates a new instance of the TagResourceCollectionIterator type.
func (iter *TagResourceCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *TagResourceCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter TagResourceCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter TagResourceCollectionIterator) Response() TagResourceCollection
Response returns the raw server response from the last page request.
func (iter TagResourceCollectionIterator) Value() TagResourceContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
TagResourceCollectionPage contains a page of TagResourceContract values.
type TagResourceCollectionPage struct {
// contains filtered or unexported fields
}
func NewTagResourceCollectionPage(cur TagResourceCollection, getNextPage func(context.Context, TagResourceCollection) (TagResourceCollection, error)) TagResourceCollectionPage
Creates a new instance of the TagResourceCollectionPage type.
func (page *TagResourceCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *TagResourceCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page TagResourceCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page TagResourceCollectionPage) Response() TagResourceCollection
Response returns the raw server response from the last page request.
func (page TagResourceCollectionPage) Values() []TagResourceContract
Values returns the slice of values for the current page or nil if there are no values.
TagResourceContract tagResource contract properties.
type TagResourceContract struct {
// Tag - Tag associated with the resource.
Tag *TagTagResourceContractProperties `json:"tag,omitempty"`
// API - Api associated with the tag.
API *APITagResourceContractProperties `json:"api,omitempty"`
// Operation - Operation associated with the tag.
Operation *OperationTagResourceContractProperties `json:"operation,omitempty"`
// Product - Product associated with the tag.
Product *ProductTagResourceContractProperties `json:"product,omitempty"`
}
TagTagResourceContractProperties contract defining the Tag property in the Tag Resource Contract
type TagTagResourceContractProperties struct {
// ID - Tag identifier
ID *string `json:"id,omitempty"`
// Name - Tag Name
Name *string `json:"name,omitempty"`
}
TemplateName enumerates the values for template name.
type TemplateName string
const (
// AccountClosedDeveloper ...
AccountClosedDeveloper TemplateName = "accountClosedDeveloper"
// ApplicationApprovedNotificationMessage ...
ApplicationApprovedNotificationMessage TemplateName = "applicationApprovedNotificationMessage"
// ConfirmSignUpIdentityDefault ...
ConfirmSignUpIdentityDefault TemplateName = "confirmSignUpIdentityDefault"
// EmailChangeIdentityDefault ...
EmailChangeIdentityDefault TemplateName = "emailChangeIdentityDefault"
// InviteUserNotificationMessage ...
InviteUserNotificationMessage TemplateName = "inviteUserNotificationMessage"
// NewCommentNotificationMessage ...
NewCommentNotificationMessage TemplateName = "newCommentNotificationMessage"
// NewDeveloperNotificationMessage ...
NewDeveloperNotificationMessage TemplateName = "newDeveloperNotificationMessage"
// NewIssueNotificationMessage ...
NewIssueNotificationMessage TemplateName = "newIssueNotificationMessage"
// PasswordResetByAdminNotificationMessage ...
PasswordResetByAdminNotificationMessage TemplateName = "passwordResetByAdminNotificationMessage"
// PasswordResetIdentityDefault ...
PasswordResetIdentityDefault TemplateName = "passwordResetIdentityDefault"
// PurchaseDeveloperNotificationMessage ...
PurchaseDeveloperNotificationMessage TemplateName = "purchaseDeveloperNotificationMessage"
// QuotaLimitApproachingDeveloperNotificationMessage ...
QuotaLimitApproachingDeveloperNotificationMessage TemplateName = "quotaLimitApproachingDeveloperNotificationMessage"
// RejectDeveloperNotificationMessage ...
RejectDeveloperNotificationMessage TemplateName = "rejectDeveloperNotificationMessage"
// RequestDeveloperNotificationMessage ...
RequestDeveloperNotificationMessage TemplateName = "requestDeveloperNotificationMessage"
)
func PossibleTemplateNameValues() []TemplateName
PossibleTemplateNameValues returns an array of possible values for the TemplateName const type.
TenantAccessClient is the apiManagement Client
type TenantAccessClient struct {
BaseClient
}
func NewTenantAccessClient(subscriptionID string) TenantAccessClient
NewTenantAccessClient creates an instance of the TenantAccessClient client.
func NewTenantAccessClientWithBaseURI(baseURI string, subscriptionID string) TenantAccessClient
NewTenantAccessClientWithBaseURI creates an instance of the TenantAccessClient 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 (client TenantAccessClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result AccessInformationContract, err error)
Get get tenant access information details. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client TenantAccessClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client TenantAccessClient) GetResponder(resp *http.Response) (result AccessInformationContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client TenantAccessClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client TenantAccessClient) RegeneratePrimaryKey(ctx context.Context, resourceGroupName string, serviceName string) (result autorest.Response, err error)
RegeneratePrimaryKey regenerate primary access key. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client TenantAccessClient) RegeneratePrimaryKeyPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
RegeneratePrimaryKeyPreparer prepares the RegeneratePrimaryKey request.
func (client TenantAccessClient) RegeneratePrimaryKeyResponder(resp *http.Response) (result autorest.Response, err error)
RegeneratePrimaryKeyResponder handles the response to the RegeneratePrimaryKey request. The method always closes the http.Response Body.
func (client TenantAccessClient) RegeneratePrimaryKeySender(req *http.Request) (*http.Response, error)
RegeneratePrimaryKeySender sends the RegeneratePrimaryKey request. The method will close the http.Response Body if it receives an error.
func (client TenantAccessClient) RegenerateSecondaryKey(ctx context.Context, resourceGroupName string, serviceName string) (result autorest.Response, err error)
RegenerateSecondaryKey regenerate secondary access key. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client TenantAccessClient) RegenerateSecondaryKeyPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
RegenerateSecondaryKeyPreparer prepares the RegenerateSecondaryKey request.
func (client TenantAccessClient) RegenerateSecondaryKeyResponder(resp *http.Response) (result autorest.Response, err error)
RegenerateSecondaryKeyResponder handles the response to the RegenerateSecondaryKey request. The method always closes the http.Response Body.
func (client TenantAccessClient) RegenerateSecondaryKeySender(req *http.Request) (*http.Response, error)
RegenerateSecondaryKeySender sends the RegenerateSecondaryKey request. The method will close the http.Response Body if it receives an error.
func (client TenantAccessClient) Update(ctx context.Context, resourceGroupName string, serviceName string, parameters AccessInformationUpdateParameters, ifMatch string) (result autorest.Response, err error)
Update update tenant access information details. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - parameters supplied to retrieve the Tenant Access Information. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client TenantAccessClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters AccessInformationUpdateParameters, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client TenantAccessClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client TenantAccessClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
TenantAccessGitClient is the apiManagement Client
type TenantAccessGitClient struct {
BaseClient
}
func NewTenantAccessGitClient(subscriptionID string) TenantAccessGitClient
NewTenantAccessGitClient creates an instance of the TenantAccessGitClient client.
func NewTenantAccessGitClientWithBaseURI(baseURI string, subscriptionID string) TenantAccessGitClient
NewTenantAccessGitClientWithBaseURI creates an instance of the TenantAccessGitClient 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 (client TenantAccessGitClient) Get(ctx context.Context, resourceGroupName string, serviceName string) (result AccessInformationContract, err error)
Get gets the Git access configuration for the tenant. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client TenantAccessGitClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client TenantAccessGitClient) GetResponder(resp *http.Response) (result AccessInformationContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client TenantAccessGitClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client TenantAccessGitClient) RegeneratePrimaryKey(ctx context.Context, resourceGroupName string, serviceName string) (result autorest.Response, err error)
RegeneratePrimaryKey regenerate primary access key for GIT. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client TenantAccessGitClient) RegeneratePrimaryKeyPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
RegeneratePrimaryKeyPreparer prepares the RegeneratePrimaryKey request.
func (client TenantAccessGitClient) RegeneratePrimaryKeyResponder(resp *http.Response) (result autorest.Response, err error)
RegeneratePrimaryKeyResponder handles the response to the RegeneratePrimaryKey request. The method always closes the http.Response Body.
func (client TenantAccessGitClient) RegeneratePrimaryKeySender(req *http.Request) (*http.Response, error)
RegeneratePrimaryKeySender sends the RegeneratePrimaryKey request. The method will close the http.Response Body if it receives an error.
func (client TenantAccessGitClient) RegenerateSecondaryKey(ctx context.Context, resourceGroupName string, serviceName string) (result autorest.Response, err error)
RegenerateSecondaryKey regenerate secondary access key for GIT. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client TenantAccessGitClient) RegenerateSecondaryKeyPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
RegenerateSecondaryKeyPreparer prepares the RegenerateSecondaryKey request.
func (client TenantAccessGitClient) RegenerateSecondaryKeyResponder(resp *http.Response) (result autorest.Response, err error)
RegenerateSecondaryKeyResponder handles the response to the RegenerateSecondaryKey request. The method always closes the http.Response Body.
func (client TenantAccessGitClient) RegenerateSecondaryKeySender(req *http.Request) (*http.Response, error)
RegenerateSecondaryKeySender sends the RegenerateSecondaryKey request. The method will close the http.Response Body if it receives an error.
TenantConfigurationClient is the apiManagement Client
type TenantConfigurationClient struct {
BaseClient
}
func NewTenantConfigurationClient(subscriptionID string) TenantConfigurationClient
NewTenantConfigurationClient creates an instance of the TenantConfigurationClient client.
func NewTenantConfigurationClientWithBaseURI(baseURI string, subscriptionID string) TenantConfigurationClient
NewTenantConfigurationClientWithBaseURI creates an instance of the TenantConfigurationClient 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 (client TenantConfigurationClient) Deploy(ctx context.Context, resourceGroupName string, serviceName string, parameters DeployConfigurationParameters) (result TenantConfigurationDeployFuture, err error)
Deploy this operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - deploy Configuration parameters.
func (client TenantConfigurationClient) DeployPreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters DeployConfigurationParameters) (*http.Request, error)
DeployPreparer prepares the Deploy request.
func (client TenantConfigurationClient) DeployResponder(resp *http.Response) (result OperationResultContract, err error)
DeployResponder handles the response to the Deploy request. The method always closes the http.Response Body.
func (client TenantConfigurationClient) DeploySender(req *http.Request) (future TenantConfigurationDeployFuture, err error)
DeploySender sends the Deploy request. The method will close the http.Response Body if it receives an error.
func (client TenantConfigurationClient) GetSyncState(ctx context.Context, resourceGroupName string, serviceName string) (result TenantConfigurationSyncStateContract, err error)
GetSyncState gets the status of the most recent synchronization between the configuration database and the Git repository. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client TenantConfigurationClient) GetSyncStatePreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
GetSyncStatePreparer prepares the GetSyncState request.
func (client TenantConfigurationClient) GetSyncStateResponder(resp *http.Response) (result TenantConfigurationSyncStateContract, err error)
GetSyncStateResponder handles the response to the GetSyncState request. The method always closes the http.Response Body.
func (client TenantConfigurationClient) GetSyncStateSender(req *http.Request) (*http.Response, error)
GetSyncStateSender sends the GetSyncState request. The method will close the http.Response Body if it receives an error.
func (client TenantConfigurationClient) Save(ctx context.Context, resourceGroupName string, serviceName string, parameters SaveConfigurationParameter) (result TenantConfigurationSaveFuture, err error)
Save this operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - save Configuration parameters.
func (client TenantConfigurationClient) SavePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters SaveConfigurationParameter) (*http.Request, error)
SavePreparer prepares the Save request.
func (client TenantConfigurationClient) SaveResponder(resp *http.Response) (result OperationResultContract, err error)
SaveResponder handles the response to the Save request. The method always closes the http.Response Body.
func (client TenantConfigurationClient) SaveSender(req *http.Request) (future TenantConfigurationSaveFuture, err error)
SaveSender sends the Save request. The method will close the http.Response Body if it receives an error.
func (client TenantConfigurationClient) Validate(ctx context.Context, resourceGroupName string, serviceName string, parameters DeployConfigurationParameters) (result TenantConfigurationValidateFuture, err error)
Validate this operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. parameters - validate Configuration parameters.
func (client TenantConfigurationClient) ValidatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters DeployConfigurationParameters) (*http.Request, error)
ValidatePreparer prepares the Validate request.
func (client TenantConfigurationClient) ValidateResponder(resp *http.Response) (result OperationResultContract, err error)
ValidateResponder handles the response to the Validate request. The method always closes the http.Response Body.
func (client TenantConfigurationClient) ValidateSender(req *http.Request) (future TenantConfigurationValidateFuture, err error)
ValidateSender sends the Validate request. The method will close the http.Response Body if it receives an error.
TenantConfigurationDeployFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type TenantConfigurationDeployFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(TenantConfigurationClient) (OperationResultContract, error)
}
func (future *TenantConfigurationDeployFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
TenantConfigurationSaveFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type TenantConfigurationSaveFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(TenantConfigurationClient) (OperationResultContract, error)
}
func (future *TenantConfigurationSaveFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
TenantConfigurationSyncStateContract tenant Configuration Synchronization State.
type TenantConfigurationSyncStateContract struct {
autorest.Response `json:"-"`
// Branch - The name of Git branch.
Branch *string `json:"branch,omitempty"`
// CommitID - The latest commit Id.
CommitID *string `json:"commitId,omitempty"`
// IsExport - value indicating if last sync was save (true) or deploy (false) operation.
IsExport *bool `json:"isExport,omitempty"`
// IsSynced - value indicating if last synchronization was later than the configuration change.
IsSynced *bool `json:"isSynced,omitempty"`
// IsGitEnabled - value indicating whether Git configuration access is enabled.
IsGitEnabled *bool `json:"isGitEnabled,omitempty"`
// SyncDate - The date of the latest synchronization. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
SyncDate *date.Time `json:"syncDate,omitempty"`
// ConfigurationChangeDate - The date of the latest configuration change. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
ConfigurationChangeDate *date.Time `json:"configurationChangeDate,omitempty"`
}
TenantConfigurationValidateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type TenantConfigurationValidateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(TenantConfigurationClient) (OperationResultContract, error)
}
func (future *TenantConfigurationValidateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
TermsOfServiceProperties terms of service contract properties.
type TermsOfServiceProperties struct {
// Text - A terms of service text.
Text *string `json:"text,omitempty"`
// Enabled - Display terms of service during a sign-up process.
Enabled *bool `json:"enabled,omitempty"`
// ConsentRequired - Ask user for consent to the terms of service.
ConsentRequired *bool `json:"consentRequired,omitempty"`
}
TokenBodyParameterContract oAuth acquire token request body parameter (www-url-form-encoded).
type TokenBodyParameterContract struct {
// Name - body parameter name.
Name *string `json:"name,omitempty"`
// Value - body parameter value.
Value *string `json:"value,omitempty"`
}
UserClient is the apiManagement Client
type UserClient struct {
BaseClient
}
func NewUserClient(subscriptionID string) UserClient
NewUserClient creates an instance of the UserClient client.
func NewUserClientWithBaseURI(baseURI string, subscriptionID string) UserClient
NewUserClientWithBaseURI creates an instance of the UserClient 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 (client UserClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserCreateParameters, ifMatch string) (result UserContract, err error)
CreateOrUpdate creates or Updates a user. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance. parameters - create or update parameters. ifMatch - eTag of the Entity. Not required when creating an entity, but required when updating an entity.
func (client UserClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserCreateParameters, ifMatch string) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client UserClient) CreateOrUpdateResponder(resp *http.Response) (result UserContract, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client UserClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client UserClient) Delete(ctx context.Context, resourceGroupName string, serviceName string, UID string, ifMatch string, deleteSubscriptions *bool, notify *bool) (result autorest.Response, err error)
Delete deletes specific user. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. deleteSubscriptions - whether to delete user's subscription or not. notify - send an Account Closed Email notification to the User.
func (client UserClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, ifMatch string, deleteSubscriptions *bool, notify *bool) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client UserClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client UserClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client UserClient) GenerateSsoURL(ctx context.Context, resourceGroupName string, serviceName string, UID string) (result GenerateSsoURLResult, err error)
GenerateSsoURL retrieves a redirection URL containing an authentication token for signing a given user into the developer portal. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance.
func (client UserClient) GenerateSsoURLPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string) (*http.Request, error)
GenerateSsoURLPreparer prepares the GenerateSsoURL request.
func (client UserClient) GenerateSsoURLResponder(resp *http.Response) (result GenerateSsoURLResult, err error)
GenerateSsoURLResponder handles the response to the GenerateSsoURL request. The method always closes the http.Response Body.
func (client UserClient) GenerateSsoURLSender(req *http.Request) (*http.Response, error)
GenerateSsoURLSender sends the GenerateSsoURL request. The method will close the http.Response Body if it receives an error.
func (client UserClient) Get(ctx context.Context, resourceGroupName string, serviceName string, UID string) (result UserContract, err error)
Get gets the details of the user specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance.
func (client UserClient) GetEntityTag(ctx context.Context, resourceGroupName string, serviceName string, UID string) (result autorest.Response, err error)
GetEntityTag gets the entity state (Etag) version of the user specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance.
func (client UserClient) GetEntityTagPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string) (*http.Request, error)
GetEntityTagPreparer prepares the GetEntityTag request.
func (client UserClient) GetEntityTagResponder(resp *http.Response) (result autorest.Response, err error)
GetEntityTagResponder handles the response to the GetEntityTag request. The method always closes the http.Response Body.
func (client UserClient) GetEntityTagSender(req *http.Request) (*http.Response, error)
GetEntityTagSender sends the GetEntityTag request. The method will close the http.Response Body if it receives an error.
func (client UserClient) GetIdentity(ctx context.Context, resourceGroupName string, serviceName string) (result CurrentUserIdentity, err error)
GetIdentity returns calling user identity information. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service.
func (client UserClient) GetIdentityPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
GetIdentityPreparer prepares the GetIdentity request.
func (client UserClient) GetIdentityResponder(resp *http.Response) (result CurrentUserIdentity, err error)
GetIdentityResponder handles the response to the GetIdentity request. The method always closes the http.Response Body.
func (client UserClient) GetIdentitySender(req *http.Request) (*http.Response, error)
GetIdentitySender sends the GetIdentity request. The method will close the http.Response Body if it receives an error.
func (client UserClient) GetPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client UserClient) GetResponder(resp *http.Response) (result UserContract, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client UserClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client UserClient) GetSharedAccessToken(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserTokenParameters) (result UserTokenResult, err error)
GetSharedAccessToken gets the Shared Access Authorization Token for the User. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance. parameters - create Authorization Token parameters.
func (client UserClient) GetSharedAccessTokenPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserTokenParameters) (*http.Request, error)
GetSharedAccessTokenPreparer prepares the GetSharedAccessToken request.
func (client UserClient) GetSharedAccessTokenResponder(resp *http.Response) (result UserTokenResult, err error)
GetSharedAccessTokenResponder handles the response to the GetSharedAccessToken request. The method always closes the http.Response Body.
func (client UserClient) GetSharedAccessTokenSender(req *http.Request) (*http.Response, error)
GetSharedAccessTokenSender sends the GetSharedAccessToken request. The method will close the http.Response Body if it receives an error.
func (client UserClient) ListByService(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result UserCollectionPage, err error)
ListByService lists a collection of registered users in the specified service instance. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. filter - | Field | Supported operators | Supported functions | |------------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | N/A | | registrationDate | ge, le, eq, ne, gt, lt | N/A | | note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client UserClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (result UserCollectionIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (client UserClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, serviceName string, filter string, top *int32, skip *int32) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (client UserClient) ListByServiceResponder(resp *http.Response) (result UserCollection, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (client UserClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
func (client UserClient) Update(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserUpdateParameters, ifMatch string) (result autorest.Response, err error)
Update updates the details of the user specified by its identifier. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance. parameters - update parameters. ifMatch - eTag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
func (client UserClient) UpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, parameters UserUpdateParameters, ifMatch string) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client UserClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client UserClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
UserCollection paged Users list representation.
type UserCollection struct {
autorest.Response `json:"-"`
// Value - Page values.
Value *[]UserContract `json:"value,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (uc UserCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
UserCollectionIterator provides access to a complete listing of UserContract values.
type UserCollectionIterator struct {
// contains filtered or unexported fields
}
func NewUserCollectionIterator(page UserCollectionPage) UserCollectionIterator
Creates a new instance of the UserCollectionIterator type.
func (iter *UserCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *UserCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter UserCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter UserCollectionIterator) Response() UserCollection
Response returns the raw server response from the last page request.
func (iter UserCollectionIterator) Value() UserContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
UserCollectionPage contains a page of UserContract values.
type UserCollectionPage struct {
// contains filtered or unexported fields
}
func NewUserCollectionPage(cur UserCollection, getNextPage func(context.Context, UserCollection) (UserCollection, error)) UserCollectionPage
Creates a new instance of the UserCollectionPage type.
func (page *UserCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *UserCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page UserCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page UserCollectionPage) Response() UserCollection
Response returns the raw server response from the last page request.
func (page UserCollectionPage) Values() []UserContract
Values returns the slice of values for the current page or nil if there are no values.
UserContract user details.
type UserContract struct {
autorest.Response `json:"-"`
// UserContractProperties - User entity contract properties.
*UserContractProperties `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"`
}
func (uc UserContract) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UserContract.
func (uc *UserContract) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for UserContract struct.
UserContractProperties user profile.
type UserContractProperties struct {
// FirstName - First name.
FirstName *string `json:"firstName,omitempty"`
// LastName - Last name.
LastName *string `json:"lastName,omitempty"`
// Email - Email address.
Email *string `json:"email,omitempty"`
// RegistrationDate - Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
RegistrationDate *date.Time `json:"registrationDate,omitempty"`
// Groups - READ-ONLY; Collection of groups user is part of.
Groups *[]GroupContractProperties `json:"groups,omitempty"`
// State - Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Possible values include: 'UserStateActive', 'UserStateBlocked', 'UserStatePending', 'UserStateDeleted'
State UserState `json:"state,omitempty"`
// Note - Optional note about a user set by the administrator.
Note *string `json:"note,omitempty"`
// Identities - Collection of user identities.
Identities *[]UserIdentityContract `json:"identities,omitempty"`
}
func (ucp UserContractProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UserContractProperties.
UserCreateParameterProperties parameters supplied to the Create User operation.
type UserCreateParameterProperties struct {
// Email - Email address. Must not be empty and must be unique within the service instance.
Email *string `json:"email,omitempty"`
// FirstName - First name.
FirstName *string `json:"firstName,omitempty"`
// LastName - Last name.
LastName *string `json:"lastName,omitempty"`
// Password - User Password. If no value is provided, a default password is generated.
Password *string `json:"password,omitempty"`
// Confirmation - Determines the type of confirmation e-mail that will be sent to the newly created user. Possible values include: 'Signup', 'Invite'
Confirmation Confirmation `json:"confirmation,omitempty"`
// State - Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Possible values include: 'UserStateActive', 'UserStateBlocked', 'UserStatePending', 'UserStateDeleted'
State UserState `json:"state,omitempty"`
// Note - Optional note about a user set by the administrator.
Note *string `json:"note,omitempty"`
// Identities - Collection of user identities.
Identities *[]UserIdentityContract `json:"identities,omitempty"`
}
UserCreateParameters user create details.
type UserCreateParameters struct {
// UserCreateParameterProperties - User entity create contract properties.
*UserCreateParameterProperties `json:"properties,omitempty"`
}
func (ucp UserCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UserCreateParameters.
func (ucp *UserCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for UserCreateParameters struct.
UserEntityBaseParameters user Entity Base Parameters set.
type UserEntityBaseParameters struct {
// State - Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Possible values include: 'UserStateActive', 'UserStateBlocked', 'UserStatePending', 'UserStateDeleted'
State UserState `json:"state,omitempty"`
// Note - Optional note about a user set by the administrator.
Note *string `json:"note,omitempty"`
// Identities - Collection of user identities.
Identities *[]UserIdentityContract `json:"identities,omitempty"`
}
UserGroupClient is the apiManagement Client
type UserGroupClient struct {
BaseClient
}
func NewUserGroupClient(subscriptionID string) UserGroupClient
NewUserGroupClient creates an instance of the UserGroupClient client.
func NewUserGroupClientWithBaseURI(baseURI string, subscriptionID string) UserGroupClient
NewUserGroupClientWithBaseURI creates an instance of the UserGroupClient 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 (client UserGroupClient) List(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (result GroupCollectionPage, err error)
List lists all user groups. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |-------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | top - number of records to return. skip - number of records to skip.
func (client UserGroupClient) ListComplete(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (result GroupCollectionIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client UserGroupClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (*http.Request, error)
ListPreparer prepares the List request.
func (client UserGroupClient) ListResponder(resp *http.Response) (result GroupCollection, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client UserGroupClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
UserIdentitiesClient is the apiManagement Client
type UserIdentitiesClient struct {
BaseClient
}
func NewUserIdentitiesClient(subscriptionID string) UserIdentitiesClient
NewUserIdentitiesClient creates an instance of the UserIdentitiesClient client.
func NewUserIdentitiesClientWithBaseURI(baseURI string, subscriptionID string) UserIdentitiesClient
NewUserIdentitiesClientWithBaseURI creates an instance of the UserIdentitiesClient 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 (client UserIdentitiesClient) List(ctx context.Context, resourceGroupName string, serviceName string, UID string) (result UserIdentityCollectionPage, err error)
List lists all user identities. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance.
func (client UserIdentitiesClient) ListComplete(ctx context.Context, resourceGroupName string, serviceName string, UID string) (result UserIdentityCollectionIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client UserIdentitiesClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string) (*http.Request, error)
ListPreparer prepares the List request.
func (client UserIdentitiesClient) ListResponder(resp *http.Response) (result UserIdentityCollection, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client UserIdentitiesClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
UserIdentityCollection list of Users Identity list representation.
type UserIdentityCollection struct {
autorest.Response `json:"-"`
// Value - User Identity values.
Value *[]UserIdentityContract `json:"value,omitempty"`
// Count - Total record count number across all pages.
Count *int64 `json:"count,omitempty"`
// NextLink - Next page link if any.
NextLink *string `json:"nextLink,omitempty"`
}
func (uic UserIdentityCollection) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
UserIdentityCollectionIterator provides access to a complete listing of UserIdentityContract values.
type UserIdentityCollectionIterator struct {
// contains filtered or unexported fields
}
func NewUserIdentityCollectionIterator(page UserIdentityCollectionPage) UserIdentityCollectionIterator
Creates a new instance of the UserIdentityCollectionIterator type.
func (iter *UserIdentityCollectionIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *UserIdentityCollectionIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter UserIdentityCollectionIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter UserIdentityCollectionIterator) Response() UserIdentityCollection
Response returns the raw server response from the last page request.
func (iter UserIdentityCollectionIterator) Value() UserIdentityContract
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
UserIdentityCollectionPage contains a page of UserIdentityContract values.
type UserIdentityCollectionPage struct {
// contains filtered or unexported fields
}
func NewUserIdentityCollectionPage(cur UserIdentityCollection, getNextPage func(context.Context, UserIdentityCollection) (UserIdentityCollection, error)) UserIdentityCollectionPage
Creates a new instance of the UserIdentityCollectionPage type.
func (page *UserIdentityCollectionPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *UserIdentityCollectionPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page UserIdentityCollectionPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page UserIdentityCollectionPage) Response() UserIdentityCollection
Response returns the raw server response from the last page request.
func (page UserIdentityCollectionPage) Values() []UserIdentityContract
Values returns the slice of values for the current page or nil if there are no values.
UserIdentityContract user identity details.
type UserIdentityContract struct {
// Provider - Identity provider name.
Provider *string `json:"provider,omitempty"`
// ID - Identifier value within provider.
ID *string `json:"id,omitempty"`
}
UserState enumerates the values for user state.
type UserState string
const (
// UserStateActive User state is active.
UserStateActive UserState = "active"
// UserStateBlocked User is blocked. Blocked users cannot authenticate at developer portal or call API.
UserStateBlocked UserState = "blocked"
// UserStateDeleted User account is closed. All identities and related entities are removed.
UserStateDeleted UserState = "deleted"
// UserStatePending User account is pending. Requires identity confirmation before it can be made active.
UserStatePending UserState = "pending"
)
func PossibleUserStateValues() []UserState
PossibleUserStateValues returns an array of possible values for the UserState const type.
UserSubscriptionClient is the apiManagement Client
type UserSubscriptionClient struct {
BaseClient
}
func NewUserSubscriptionClient(subscriptionID string) UserSubscriptionClient
NewUserSubscriptionClient creates an instance of the UserSubscriptionClient client.
func NewUserSubscriptionClientWithBaseURI(baseURI string, subscriptionID string) UserSubscriptionClient
NewUserSubscriptionClientWithBaseURI creates an instance of the UserSubscriptionClient 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 (client UserSubscriptionClient) List(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionPage, err error)
List lists the collection of subscriptions of the specified user. Parameters: resourceGroupName - the name of the resource group. serviceName - the name of the API Management service. UID - user identifier. Must be unique in the current API Management service instance. filter - | Field | Supported operators | Supported functions | |--------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | top - number of records to return. skip - number of records to skip.
func (client UserSubscriptionClient) ListComplete(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (result SubscriptionCollectionIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client UserSubscriptionClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string, UID string, filter string, top *int32, skip *int32) (*http.Request, error)
ListPreparer prepares the List request.
func (client UserSubscriptionClient) ListResponder(resp *http.Response) (result SubscriptionCollection, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client UserSubscriptionClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
UserTokenParameters parameters supplied to the Get User Token operation.
type UserTokenParameters struct {
// KeyType - The Key to be used to generate token for user. Possible values include: 'Primary', 'Secondary'
KeyType KeyType `json:"keyType,omitempty"`
// Expiry - The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
Expiry *date.Time `json:"expiry,omitempty"`
}
UserTokenResult get User Token response details.
type UserTokenResult struct {
autorest.Response `json:"-"`
// Value - Shared Access Authorization token for the User.
Value *string `json:"value,omitempty"`
}
UserUpdateParameters user update parameters.
type UserUpdateParameters struct {
// UserUpdateParametersProperties - User entity update contract properties.
*UserUpdateParametersProperties `json:"properties,omitempty"`
}
func (uup UserUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UserUpdateParameters.
func (uup *UserUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for UserUpdateParameters struct.
UserUpdateParametersProperties parameters supplied to the Update User operation.
type UserUpdateParametersProperties struct {
// Email - Email address. Must not be empty and must be unique within the service instance.
Email *string `json:"email,omitempty"`
// Password - User Password.
Password *string `json:"password,omitempty"`
// FirstName - First name.
FirstName *string `json:"firstName,omitempty"`
// LastName - Last name.
LastName *string `json:"lastName,omitempty"`
// State - Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Possible values include: 'UserStateActive', 'UserStateBlocked', 'UserStatePending', 'UserStateDeleted'
State UserState `json:"state,omitempty"`
// Note - Optional note about a user set by the administrator.
Note *string `json:"note,omitempty"`
// Identities - Collection of user identities.
Identities *[]UserIdentityContract `json:"identities,omitempty"`
}
VersioningScheme enumerates the values for versioning scheme.
type VersioningScheme string
const (
// VersioningSchemeHeader The API Version is passed in a HTTP header.
VersioningSchemeHeader VersioningScheme = "Header"
// VersioningSchemeQuery The API Version is passed in a query parameter.
VersioningSchemeQuery VersioningScheme = "Query"
// VersioningSchemeSegment The API Version is passed in a path segment.
VersioningSchemeSegment VersioningScheme = "Segment"
)
func PossibleVersioningSchemeValues() []VersioningScheme
PossibleVersioningSchemeValues returns an array of possible values for the VersioningScheme const type.
VersioningScheme1 enumerates the values for versioning scheme 1.
type VersioningScheme1 string
const (
// VersioningScheme1Header ...
VersioningScheme1Header VersioningScheme1 = "Header"
// VersioningScheme1Query ...
VersioningScheme1Query VersioningScheme1 = "Query"
// VersioningScheme1Segment ...
VersioningScheme1Segment VersioningScheme1 = "Segment"
)
func PossibleVersioningScheme1Values() []VersioningScheme1
PossibleVersioningScheme1Values returns an array of possible values for the VersioningScheme1 const type.
VirtualNetworkConfiguration configuration of a virtual network to which API Management service is deployed.
type VirtualNetworkConfiguration struct {
// Vnetid - READ-ONLY; The virtual network ID. This is typically a GUID. Expect a null GUID by default.
Vnetid *string `json:"vnetid,omitempty"`
// Subnetname - READ-ONLY; The name of the subnet.
Subnetname *string `json:"subnetname,omitempty"`
// SubnetResourceID - The full resource ID of a subnet in a virtual network to deploy the API Management service in.
SubnetResourceID *string `json:"subnetResourceId,omitempty"`
}
func (vnc VirtualNetworkConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for VirtualNetworkConfiguration.
VirtualNetworkType enumerates the values for virtual network type.
type VirtualNetworkType string
const (
// VirtualNetworkTypeExternal The service is part of Virtual Network and it is accessible from Internet.
VirtualNetworkTypeExternal VirtualNetworkType = "External"
// VirtualNetworkTypeInternal The service is part of Virtual Network and it is only accessible from within
// the virtual network.
VirtualNetworkTypeInternal VirtualNetworkType = "Internal"
// VirtualNetworkTypeNone The service is not part of any Virtual Network.
VirtualNetworkTypeNone VirtualNetworkType = "None"
)
func PossibleVirtualNetworkTypeValues() []VirtualNetworkType
PossibleVirtualNetworkTypeValues returns an array of possible values for the VirtualNetworkType const type.
X509CertificateName properties of server X509Names.
type X509CertificateName struct {
// Name - Common Name of the Certificate.
Name *string `json:"name,omitempty"`
// IssuerCertificateThumbprint - Thumbprint for the Issuer of the Certificate.
IssuerCertificateThumbprint *string `json:"issuerCertificateThumbprint,omitempty"`
}
| Name | Synopsis |
|---|---|
| .. | |
| apimanagementapi | Deprecated: Please note, this package has been deprecated. |