Documentation ¶
Overview ¶
Package apimdeployment implements the Azure ARM Apimdeployment service API version 2016-07-07.
Use these REST APIs to manage Azure API Management deployment.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type APIManagementServiceBackupRestoreParameters
- type APIManagementServiceBaseParameters
- type APIManagementServiceCheckNameAvailabilityParameters
- type APIManagementServiceGetSsoTokenResult
- type APIManagementServiceListResult
- type APIManagementServiceManageDeploymentsParameters
- type APIManagementServiceNameAvailabilityResult
- type APIManagementServiceProperties
- type APIManagementServiceResource
- type APIManagementServiceSkuProperties
- type APIManagementServiceUpdateHostnameParameters
- type APIManagementServiceUploadCertificateParameters
- type APIManagementServicesClient
- func (client APIManagementServicesClient) Backup(resourceGroupName string, serviceName string, ...) (result autorest.Response, err error)
- func (client APIManagementServicesClient) BackupPreparer(resourceGroupName string, serviceName string, ...) (*http.Request, error)
- func (client APIManagementServicesClient) BackupResponder(resp *http.Response) (result autorest.Response, err error)
- func (client APIManagementServicesClient) BackupSender(req *http.Request) (*http.Response, error)
- func (client APIManagementServicesClient) CheckNameAvailability(parameters APIManagementServiceCheckNameAvailabilityParameters) (result APIManagementServiceNameAvailabilityResult, err error)
- func (client APIManagementServicesClient) CheckNameAvailabilityPreparer(parameters APIManagementServiceCheckNameAvailabilityParameters) (*http.Request, error)
- func (client APIManagementServicesClient) CheckNameAvailabilityResponder(resp *http.Response) (result APIManagementServiceNameAvailabilityResult, err error)
- func (client APIManagementServicesClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
- func (client APIManagementServicesClient) CreateOrUpdate(resourceGroupName string, serviceName string, ...) (result APIManagementServiceResource, err error)
- func (client APIManagementServicesClient) CreateOrUpdatePreparer(resourceGroupName string, serviceName string, ...) (*http.Request, error)
- func (client APIManagementServicesClient) CreateOrUpdateResponder(resp *http.Response) (result APIManagementServiceResource, err error)
- func (client APIManagementServicesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client APIManagementServicesClient) Delete(resourceGroupName string, serviceName string) (result ErrorResponse, err error)
- func (client APIManagementServicesClient) DeletePreparer(resourceGroupName string, serviceName string) (*http.Request, error)
- func (client APIManagementServicesClient) DeleteResponder(resp *http.Response) (result ErrorResponse, err error)
- func (client APIManagementServicesClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client APIManagementServicesClient) Get(resourceGroupName string, serviceName string) (result SetObject, err error)
- func (client APIManagementServicesClient) GetPreparer(resourceGroupName string, serviceName string) (*http.Request, error)
- func (client APIManagementServicesClient) GetResponder(resp *http.Response) (result SetObject, err error)
- func (client APIManagementServicesClient) GetSender(req *http.Request) (*http.Response, error)
- func (client APIManagementServicesClient) GetSsoToken(resourceGroupName string, serviceName string) (result APIManagementServiceGetSsoTokenResult, err error)
- func (client APIManagementServicesClient) GetSsoTokenPreparer(resourceGroupName string, serviceName string) (*http.Request, error)
- func (client APIManagementServicesClient) GetSsoTokenResponder(resp *http.Response) (result APIManagementServiceGetSsoTokenResult, err error)
- func (client APIManagementServicesClient) GetSsoTokenSender(req *http.Request) (*http.Response, error)
- func (client APIManagementServicesClient) List() (result APIManagementServiceListResult, err error)
- func (client APIManagementServicesClient) ListByResourceGroup(resourceGroupName string) (result APIManagementServiceListResult, err error)
- func (client APIManagementServicesClient) ListByResourceGroupNextResults(lastResults APIManagementServiceListResult) (result APIManagementServiceListResult, err error)
- func (client APIManagementServicesClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)
- func (client APIManagementServicesClient) ListByResourceGroupResponder(resp *http.Response) (result APIManagementServiceListResult, err error)
- func (client APIManagementServicesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client APIManagementServicesClient) ListNextResults(lastResults APIManagementServiceListResult) (result APIManagementServiceListResult, err error)
- func (client APIManagementServicesClient) ListPreparer() (*http.Request, error)
- func (client APIManagementServicesClient) ListResponder(resp *http.Response) (result APIManagementServiceListResult, err error)
- func (client APIManagementServicesClient) ListSender(req *http.Request) (*http.Response, error)
- func (client APIManagementServicesClient) ManageDeployments(resourceGroupName string, serviceName string, ...) (result autorest.Response, err error)
- func (client APIManagementServicesClient) ManageDeploymentsPreparer(resourceGroupName string, serviceName string, ...) (*http.Request, error)
- func (client APIManagementServicesClient) ManageDeploymentsResponder(resp *http.Response) (result autorest.Response, err error)
- func (client APIManagementServicesClient) ManageDeploymentsSender(req *http.Request) (*http.Response, error)
- func (client APIManagementServicesClient) Restore(resourceGroupName string, serviceName string, ...) (result autorest.Response, err error)
- func (client APIManagementServicesClient) RestorePreparer(resourceGroupName string, serviceName string, ...) (*http.Request, error)
- func (client APIManagementServicesClient) RestoreResponder(resp *http.Response) (result autorest.Response, err error)
- func (client APIManagementServicesClient) RestoreSender(req *http.Request) (*http.Response, error)
- func (client APIManagementServicesClient) Update(resourceGroupName string, serviceName string, ...) (result autorest.Response, err error)
- func (client APIManagementServicesClient) UpdateHostname(resourceGroupName string, serviceName string, ...) (result autorest.Response, err error)
- func (client APIManagementServicesClient) UpdateHostnamePreparer(resourceGroupName string, serviceName string, ...) (*http.Request, error)
- func (client APIManagementServicesClient) UpdateHostnameResponder(resp *http.Response) (result autorest.Response, err error)
- func (client APIManagementServicesClient) UpdateHostnameSender(req *http.Request) (*http.Response, error)
- func (client APIManagementServicesClient) UpdatePreparer(resourceGroupName string, serviceName string, ...) (*http.Request, error)
- func (client APIManagementServicesClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
- func (client APIManagementServicesClient) UpdateSender(req *http.Request) (*http.Response, error)
- func (client APIManagementServicesClient) UploadCertificate(resourceGroupName string, serviceName string, ...) (result CertificateInformation, err error)
- func (client APIManagementServicesClient) UploadCertificatePreparer(resourceGroupName string, serviceName string, ...) (*http.Request, error)
- func (client APIManagementServicesClient) UploadCertificateResponder(resp *http.Response) (result CertificateInformation, err error)
- func (client APIManagementServicesClient) UploadCertificateSender(req *http.Request) (*http.Response, error)
- type AdditionalRegion
- type CertificateInformation
- type ErrorResponse
- type HostnameConfiguration
- type HostnameType
- type ManagementClient
- type NameAvailabilityReason
- type SetObject
- type SkuType
- type VirtualNetworkConfiguration
- type VirtualNetworkType
Constants ¶
const ( // APIVersion is the version of the Apimdeployment APIVersion = "2016-07-07" // DefaultBaseURI is the default URI used for the service Apimdeployment DefaultBaseURI = "https://management.azure.com" )
Variables ¶
This section is empty.
Functions ¶
func UserAgent ¶
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version ¶
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Types ¶
type APIManagementServiceBackupRestoreParameters ¶
type APIManagementServiceBackupRestoreParameters struct { StorageAccount *string `json:"storageAccount,omitempty"` AccessKey *string `json:"accessKey,omitempty"` ContainerName *string `json:"containerName,omitempty"` BackupName *string `json:"backupName,omitempty"` }
APIManagementServiceBackupRestoreParameters is parameters supplied to the Backup/Restore of an API Management service operation.
type APIManagementServiceBaseParameters ¶
type APIManagementServiceBaseParameters struct { Tags *map[string]*string `json:"tags,omitempty"` *APIManagementServiceProperties `json:"properties,omitempty"` Sku *APIManagementServiceSkuProperties `json:"sku,omitempty"` }
APIManagementServiceBaseParameters is parameters supplied to the Update API Management service operation.
type APIManagementServiceCheckNameAvailabilityParameters ¶
type APIManagementServiceCheckNameAvailabilityParameters struct {
Name *string `json:"name,omitempty"`
}
APIManagementServiceCheckNameAvailabilityParameters is parameters supplied to the CheckNameAvailability operation.
type APIManagementServiceGetSsoTokenResult ¶
type APIManagementServiceGetSsoTokenResult struct { autorest.Response `json:"-"` RedirectURI *string `json:"redirect_uri,omitempty"` }
APIManagementServiceGetSsoTokenResult is the response of the GetSsoToken operation.
type APIManagementServiceListResult ¶
type APIManagementServiceListResult struct { autorest.Response `json:"-"` Value *[]APIManagementServiceResource `json:"value,omitempty"` NextLink *string `json:"nextLink,omitempty"` }
APIManagementServiceListResult is the response of the List API Management services operation.
func (APIManagementServiceListResult) APIManagementServiceListResultPreparer ¶
func (client APIManagementServiceListResult) APIManagementServiceListResultPreparer() (*http.Request, error)
APIManagementServiceListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.
type APIManagementServiceManageDeploymentsParameters ¶
type APIManagementServiceManageDeploymentsParameters struct { Location *string `json:"location,omitempty"` SkuType SkuType `json:"skuType,omitempty"` SkuUnitCount *int32 `json:"skuUnitCount,omitempty"` AdditionalLocations *[]AdditionalRegion `json:"additionalLocations,omitempty"` VpnConfiguration *VirtualNetworkConfiguration `json:"vpnConfiguration,omitempty"` VpnType VirtualNetworkType `json:"vpnType,omitempty"` }
APIManagementServiceManageDeploymentsParameters is parameters supplied to the ManageDeployments operation.
type APIManagementServiceNameAvailabilityResult ¶
type APIManagementServiceNameAvailabilityResult struct { autorest.Response `json:"-"` NameAvailable *bool `json:"nameAvailable,omitempty"` Message *string `json:"message,omitempty"` Reason NameAvailabilityReason `json:"reason,omitempty"` }
APIManagementServiceNameAvailabilityResult is response of the CheckNameAvailability operation.
type APIManagementServiceProperties ¶
type APIManagementServiceProperties struct { PublisherEmail *string `json:"publisherEmail,omitempty"` PublisherName *string `json:"publisherName,omitempty"` ProvisioningState *string `json:"provisioningState,omitempty"` TargetProvisioningState *string `json:"targetProvisioningState,omitempty"` CreatedAtUtc *date.Time `json:"createdAtUtc,omitempty"` RuntimeURL *string `json:"runtimeUrl,omitempty"` PortalURL *string `json:"portalUrl,omitempty"` ManagementAPIURL *string `json:"managementApiUrl,omitempty"` ScmURL *string `json:"scmUrl,omitempty"` AddresserEmail *string `json:"addresserEmail,omitempty"` HostnameConfigurations *[]HostnameConfiguration `json:"hostnameConfigurations,omitempty"` StaticIPs *[]string `json:"staticIPs,omitempty"` Vpnconfiguration *VirtualNetworkConfiguration `json:"vpnconfiguration,omitempty"` AdditionalLocations *[]AdditionalRegion `json:"additionalLocations,omitempty"` CustomProperties *map[string]*string `json:"customProperties,omitempty"` VpnType VirtualNetworkType `json:"vpnType,omitempty"` }
APIManagementServiceProperties is properties of an API Management service resource description.
type APIManagementServiceResource ¶
type APIManagementServiceResource struct { autorest.Response `json:"-"` Tags *map[string]*string `json:"tags,omitempty"` *APIManagementServiceProperties `json:"properties,omitempty"` Sku *APIManagementServiceSkuProperties `json:"sku,omitempty"` ID *string `json:"id,omitempty"` Location *string `json:"location,omitempty"` Name *string `json:"name,omitempty"` Type *string `json:"type,omitempty"` Etag *string `json:"etag,omitempty"` }
APIManagementServiceResource is description of an API Management service resource.
type APIManagementServiceSkuProperties ¶
type APIManagementServiceSkuProperties struct { Name SkuType `json:"name,omitempty"` Capacity *int32 `json:"capacity,omitempty"` }
APIManagementServiceSkuProperties is aPI Management service resource SKU properties.
type APIManagementServiceUpdateHostnameParameters ¶
type APIManagementServiceUpdateHostnameParameters struct { Update *[]HostnameConfiguration `json:"update,omitempty"` Delete *[]HostnameType `json:"delete,omitempty"` }
APIManagementServiceUpdateHostnameParameters is parameters supplied to the UpdateHostname operation.
type APIManagementServiceUploadCertificateParameters ¶
type APIManagementServiceUploadCertificateParameters struct { Type HostnameType `json:"type,omitempty"` Certificate *string `json:"certificate,omitempty"` CertificatePassword *string `json:"certificate_password,omitempty"` }
APIManagementServiceUploadCertificateParameters is parameters supplied to the Upload SSL certificate for an API Management service operation.
type APIManagementServicesClient ¶
type APIManagementServicesClient struct {
ManagementClient
}
APIManagementServicesClient is the use these REST APIs to manage Azure API Management deployment.
func NewAPIManagementServicesClient ¶
func NewAPIManagementServicesClient(subscriptionID string) APIManagementServicesClient
NewAPIManagementServicesClient creates an instance of the APIManagementServicesClient client.
func NewAPIManagementServicesClientWithBaseURI ¶
func NewAPIManagementServicesClientWithBaseURI(baseURI string, subscriptionID string) APIManagementServicesClient
NewAPIManagementServicesClientWithBaseURI creates an instance of the APIManagementServicesClient client.
func (APIManagementServicesClient) Backup ¶
func (client APIManagementServicesClient) Backup(resourceGroupName string, serviceName string, parameters APIManagementServiceBackupRestoreParameters, cancel <-chan struct{}) (result autorest.Response, 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. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters supplied to the ApiManagementServices_Backup operation.
func (APIManagementServicesClient) BackupPreparer ¶
func (client APIManagementServicesClient) BackupPreparer(resourceGroupName string, serviceName string, parameters APIManagementServiceBackupRestoreParameters, cancel <-chan struct{}) (*http.Request, error)
BackupPreparer prepares the Backup request.
func (APIManagementServicesClient) BackupResponder ¶
func (client APIManagementServicesClient) BackupResponder(resp *http.Response) (result autorest.Response, err error)
BackupResponder handles the response to the Backup request. The method always closes the http.Response Body.
func (APIManagementServicesClient) BackupSender ¶
BackupSender sends the Backup request. The method will close the http.Response Body if it receives an error.
func (APIManagementServicesClient) CheckNameAvailability ¶
func (client APIManagementServicesClient) CheckNameAvailability(parameters APIManagementServiceCheckNameAvailabilityParameters) (result APIManagementServiceNameAvailabilityResult, err error)
CheckNameAvailability checks availability and correctness of a name for an API Management service.
parameters is parameters supplied to the CheckNameAvailability operation.
func (APIManagementServicesClient) CheckNameAvailabilityPreparer ¶
func (client APIManagementServicesClient) CheckNameAvailabilityPreparer(parameters APIManagementServiceCheckNameAvailabilityParameters) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
func (APIManagementServicesClient) CheckNameAvailabilityResponder ¶
func (client APIManagementServicesClient) CheckNameAvailabilityResponder(resp *http.Response) (result APIManagementServiceNameAvailabilityResult, err error)
CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.
func (APIManagementServicesClient) CheckNameAvailabilitySender ¶
func (client APIManagementServicesClient) 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 (APIManagementServicesClient) CreateOrUpdate ¶
func (client APIManagementServicesClient) CreateOrUpdate(resourceGroupName string, serviceName string, parameters APIManagementServiceResource) (result APIManagementServiceResource, err error)
CreateOrUpdate creates or updates an API Management service. This is long running operation and could take several minutes to complete.
resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters supplied to the CreateOrUpdate API Management service operation.
func (APIManagementServicesClient) CreateOrUpdatePreparer ¶
func (client APIManagementServicesClient) CreateOrUpdatePreparer(resourceGroupName string, serviceName string, parameters APIManagementServiceResource) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (APIManagementServicesClient) CreateOrUpdateResponder ¶
func (client APIManagementServicesClient) CreateOrUpdateResponder(resp *http.Response) (result APIManagementServiceResource, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (APIManagementServicesClient) CreateOrUpdateSender ¶
func (client APIManagementServicesClient) 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 (APIManagementServicesClient) Delete ¶
func (client APIManagementServicesClient) Delete(resourceGroupName string, serviceName string) (result ErrorResponse, err error)
Delete deletes an existing API Management service.
resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.
func (APIManagementServicesClient) DeletePreparer ¶
func (client APIManagementServicesClient) DeletePreparer(resourceGroupName string, serviceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (APIManagementServicesClient) DeleteResponder ¶
func (client APIManagementServicesClient) DeleteResponder(resp *http.Response) (result ErrorResponse, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (APIManagementServicesClient) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (APIManagementServicesClient) Get ¶
func (client APIManagementServicesClient) Get(resourceGroupName string, serviceName string) (result SetObject, err error)
Get gets an API Management service resource description.
resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.
func (APIManagementServicesClient) GetPreparer ¶
func (client APIManagementServicesClient) GetPreparer(resourceGroupName string, serviceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (APIManagementServicesClient) GetResponder ¶
func (client APIManagementServicesClient) GetResponder(resp *http.Response) (result SetObject, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (APIManagementServicesClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (APIManagementServicesClient) GetSsoToken ¶
func (client APIManagementServicesClient) GetSsoToken(resourceGroupName string, serviceName string) (result APIManagementServiceGetSsoTokenResult, err error)
GetSsoToken gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
resourceGroupName is the name of the resource group. serviceName is the name of the API Management service.
func (APIManagementServicesClient) GetSsoTokenPreparer ¶
func (client APIManagementServicesClient) GetSsoTokenPreparer(resourceGroupName string, serviceName string) (*http.Request, error)
GetSsoTokenPreparer prepares the GetSsoToken request.
func (APIManagementServicesClient) GetSsoTokenResponder ¶
func (client APIManagementServicesClient) GetSsoTokenResponder(resp *http.Response) (result APIManagementServiceGetSsoTokenResult, err error)
GetSsoTokenResponder handles the response to the GetSsoToken request. The method always closes the http.Response Body.
func (APIManagementServicesClient) GetSsoTokenSender ¶
func (client APIManagementServicesClient) 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 (APIManagementServicesClient) List ¶
func (client APIManagementServicesClient) List() (result APIManagementServiceListResult, err error)
List lists all API Management services within an Azure subscription.
func (APIManagementServicesClient) ListByResourceGroup ¶
func (client APIManagementServicesClient) ListByResourceGroup(resourceGroupName string) (result APIManagementServiceListResult, err error)
ListByResourceGroup list all API Management services within a resource group.
resourceGroupName is the name of the resource group.
func (APIManagementServicesClient) ListByResourceGroupNextResults ¶
func (client APIManagementServicesClient) ListByResourceGroupNextResults(lastResults APIManagementServiceListResult) (result APIManagementServiceListResult, err error)
ListByResourceGroupNextResults retrieves the next set of results, if any.
func (APIManagementServicesClient) ListByResourceGroupPreparer ¶
func (client APIManagementServicesClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (APIManagementServicesClient) ListByResourceGroupResponder ¶
func (client APIManagementServicesClient) ListByResourceGroupResponder(resp *http.Response) (result APIManagementServiceListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (APIManagementServicesClient) ListByResourceGroupSender ¶
func (client APIManagementServicesClient) 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 (APIManagementServicesClient) ListNextResults ¶
func (client APIManagementServicesClient) ListNextResults(lastResults APIManagementServiceListResult) (result APIManagementServiceListResult, err error)
ListNextResults retrieves the next set of results, if any.
func (APIManagementServicesClient) ListPreparer ¶
func (client APIManagementServicesClient) ListPreparer() (*http.Request, error)
ListPreparer prepares the List request.
func (APIManagementServicesClient) ListResponder ¶
func (client APIManagementServicesClient) ListResponder(resp *http.Response) (result APIManagementServiceListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (APIManagementServicesClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (APIManagementServicesClient) ManageDeployments ¶
func (client APIManagementServicesClient) ManageDeployments(resourceGroupName string, serviceName string, parameters APIManagementServiceManageDeploymentsParameters, cancel <-chan struct{}) (result autorest.Response, err error)
ManageDeployments manages deployments of an API Management service. This operation can be used to do the following: Change SKU, Change SKU Units, Change Service Tier (Developer/Standard/Premium) and Manage VPN Configuration. This is a long running operation and can take several minutes to complete. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters supplied to the ManageDeployments operation.
func (APIManagementServicesClient) ManageDeploymentsPreparer ¶
func (client APIManagementServicesClient) ManageDeploymentsPreparer(resourceGroupName string, serviceName string, parameters APIManagementServiceManageDeploymentsParameters, cancel <-chan struct{}) (*http.Request, error)
ManageDeploymentsPreparer prepares the ManageDeployments request.
func (APIManagementServicesClient) ManageDeploymentsResponder ¶
func (client APIManagementServicesClient) ManageDeploymentsResponder(resp *http.Response) (result autorest.Response, err error)
ManageDeploymentsResponder handles the response to the ManageDeployments request. The method always closes the http.Response Body.
func (APIManagementServicesClient) ManageDeploymentsSender ¶
func (client APIManagementServicesClient) ManageDeploymentsSender(req *http.Request) (*http.Response, error)
ManageDeploymentsSender sends the ManageDeployments request. The method will close the http.Response Body if it receives an error.
func (APIManagementServicesClient) Restore ¶
func (client APIManagementServicesClient) Restore(resourceGroupName string, serviceName string, parameters APIManagementServiceBackupRestoreParameters, cancel <-chan struct{}) (result autorest.Response, err error)
Restore restores a backup of an API Management service created using the ApiManagementServices_Backup operation on the current service. This is a long running operation and could take several minutes to complete. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters supplied to the Restore API Management service from backup operation.
func (APIManagementServicesClient) RestorePreparer ¶
func (client APIManagementServicesClient) RestorePreparer(resourceGroupName string, serviceName string, parameters APIManagementServiceBackupRestoreParameters, cancel <-chan struct{}) (*http.Request, error)
RestorePreparer prepares the Restore request.
func (APIManagementServicesClient) RestoreResponder ¶
func (client APIManagementServicesClient) RestoreResponder(resp *http.Response) (result autorest.Response, err error)
RestoreResponder handles the response to the Restore request. The method always closes the http.Response Body.
func (APIManagementServicesClient) RestoreSender ¶
RestoreSender sends the Restore request. The method will close the http.Response Body if it receives an error.
func (APIManagementServicesClient) Update ¶
func (client APIManagementServicesClient) Update(resourceGroupName string, serviceName string, parameters APIManagementServiceBaseParameters, cancel <-chan struct{}) (result autorest.Response, err error)
Update updates an existing API Management service. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters supplied to the CreateOrUpdate API Management service operation.
func (APIManagementServicesClient) UpdateHostname ¶
func (client APIManagementServicesClient) UpdateHostname(resourceGroupName string, serviceName string, parameters APIManagementServiceUpdateHostnameParameters, cancel <-chan struct{}) (result autorest.Response, 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 method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters supplied to the UpdateHostname operation.
func (APIManagementServicesClient) UpdateHostnamePreparer ¶
func (client APIManagementServicesClient) UpdateHostnamePreparer(resourceGroupName string, serviceName string, parameters APIManagementServiceUpdateHostnameParameters, cancel <-chan struct{}) (*http.Request, error)
UpdateHostnamePreparer prepares the UpdateHostname request.
func (APIManagementServicesClient) UpdateHostnameResponder ¶
func (client APIManagementServicesClient) UpdateHostnameResponder(resp *http.Response) (result autorest.Response, err error)
UpdateHostnameResponder handles the response to the UpdateHostname request. The method always closes the http.Response Body.
func (APIManagementServicesClient) UpdateHostnameSender ¶
func (client APIManagementServicesClient) UpdateHostnameSender(req *http.Request) (*http.Response, error)
UpdateHostnameSender sends the UpdateHostname request. The method will close the http.Response Body if it receives an error.
func (APIManagementServicesClient) UpdatePreparer ¶
func (client APIManagementServicesClient) UpdatePreparer(resourceGroupName string, serviceName string, parameters APIManagementServiceBaseParameters, cancel <-chan struct{}) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (APIManagementServicesClient) UpdateResponder ¶
func (client APIManagementServicesClient) 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 (APIManagementServicesClient) UpdateSender ¶
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
func (APIManagementServicesClient) UploadCertificate ¶
func (client APIManagementServicesClient) UploadCertificate(resourceGroupName string, serviceName string, parameters APIManagementServiceUploadCertificateParameters) (result CertificateInformation, err error)
UploadCertificate upload Custom Domain SSL certificate for an API Management service.
resourceGroupName is the name of the resource group. serviceName is the name of the API Management service. parameters is parameters supplied to the Upload SSL certificate for an API Management service operation.
func (APIManagementServicesClient) UploadCertificatePreparer ¶
func (client APIManagementServicesClient) UploadCertificatePreparer(resourceGroupName string, serviceName string, parameters APIManagementServiceUploadCertificateParameters) (*http.Request, error)
UploadCertificatePreparer prepares the UploadCertificate request.
func (APIManagementServicesClient) UploadCertificateResponder ¶
func (client APIManagementServicesClient) 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 (APIManagementServicesClient) UploadCertificateSender ¶
func (client APIManagementServicesClient) 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.
type AdditionalRegion ¶
type AdditionalRegion struct { Location *string `json:"location,omitempty"` SkuType SkuType `json:"skuType,omitempty"` SkuUnitCount *int32 `json:"skuUnitCount,omitempty"` StaticIPs *[]string `json:"staticIPs,omitempty"` Vpnconfiguration *VirtualNetworkConfiguration `json:"vpnconfiguration,omitempty"` }
AdditionalRegion is description of an additional API Management resource location.
type CertificateInformation ¶
type CertificateInformation struct { autorest.Response `json:"-"` Expiry *date.Time `json:"expiry,omitempty"` Thumbprint *string `json:"thumbprint,omitempty"` Subject *string `json:"subject,omitempty"` }
CertificateInformation is sSL certificate information.
type ErrorResponse ¶
type ErrorResponse struct { autorest.Response `json:"-"` Code *string `json:"code,omitempty"` Message *string `json:"message,omitempty"` }
ErrorResponse is error Response.
type HostnameConfiguration ¶
type HostnameConfiguration struct { Type HostnameType `json:"type,omitempty"` Hostname *string `json:"hostname,omitempty"` Certificate *CertificateInformation `json:"certificate,omitempty"` }
HostnameConfiguration is custom hostname configuration.
type HostnameType ¶
type HostnameType string
HostnameType enumerates the values for hostname type.
const ( // Management specifies the management state for hostname type. Management HostnameType = "Management" // Portal specifies the portal state for hostname type. Portal HostnameType = "Portal" // Proxy specifies the proxy state for hostname type. Proxy HostnameType = "Proxy" // Scm specifies the scm state for hostname type. Scm HostnameType = "Scm" )
type ManagementClient ¶
type ManagementClient struct { autorest.Client BaseURI string APIVersion string SubscriptionID string }
ManagementClient is the base client for Apimdeployment.
func New ¶
func New(subscriptionID string) ManagementClient
New creates an instance of the ManagementClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient
NewWithBaseURI creates an instance of the ManagementClient client.
type NameAvailabilityReason ¶
type NameAvailabilityReason string
NameAvailabilityReason enumerates the values for name availability reason.
const ( // AlreadyExists specifies the already exists state for name availability // reason. AlreadyExists NameAvailabilityReason = "AlreadyExists" // Invalid specifies the invalid state for name availability reason. Invalid NameAvailabilityReason = "Invalid" // Valid specifies the valid state for name availability reason. Valid NameAvailabilityReason = "Valid" )
type SetObject ¶
type SetObject struct { autorest.Response `json:"-"` Value *map[string]interface{} `json:"value,omitempty"` }
SetObject is
type VirtualNetworkConfiguration ¶
type VirtualNetworkConfiguration struct { Vnetid *string `json:"vnetid,omitempty"` Subnetname *string `json:"subnetname,omitempty"` SubnetResourceID *string `json:"subnetResourceId,omitempty"` Location *string `json:"location,omitempty"` }
VirtualNetworkConfiguration is configuration of a virtual network to which API Management service is deployed.
type VirtualNetworkType ¶
type VirtualNetworkType string
VirtualNetworkType enumerates the values for virtual network type.
const ( // External specifies the external state for virtual network type. External VirtualNetworkType = "External" // Internal specifies the internal state for virtual network type. Internal VirtualNetworkType = "Internal" // None specifies the none state for virtual network type. None VirtualNetworkType = "None" )