WebServices interface
Interface representing a WebServices.
Methods
| begin |
Create or update a web service. This call will overwrite an existing web service. Note that there is no warning or confirmation. This is a nonrecoverable operation. If your intent is to create a new web service, call the Get operation first to verify that it does not exist. |
| begin |
Create or update a web service. This call will overwrite an existing web service. Note that there is no warning or confirmation. This is a nonrecoverable operation. If your intent is to create a new web service, call the Get operation first to verify that it does not exist. |
| begin |
Creates an encrypted credentials parameter blob for the specified region. To get the web service from a region other than the region in which it has been created, you must first call Create Regional Web Services Properties to create a copy of the encrypted credential parameter blob in that region. You only need to do this before the first time that you get the web service in the new region. |
| begin |
Creates an encrypted credentials parameter blob for the specified region. To get the web service from a region other than the region in which it has been created, you must first call Create Regional Web Services Properties to create a copy of the encrypted credential parameter blob in that region. You only need to do this before the first time that you get the web service in the new region. |
| begin |
Modifies an existing web service resource. The PATCH API call is an asynchronous operation. To determine whether it has completed successfully, you must perform a Get operation. |
| begin |
Modifies an existing web service resource. The PATCH API call is an asynchronous operation. To determine whether it has completed successfully, you must perform a Get operation. |
| begin |
Deletes the specified web service. |
| begin |
Deletes the specified web service. |
| get(string, string, Web |
Gets the Web Service Definition as specified by a subscription, resource group, and name. Note that the storage credentials and web service keys are not returned by this call. To get the web service access keys, call List Keys. |
| list |
Gets the web services in the specified resource group. |
| list |
Gets the web services in the specified subscription. |
| list |
Gets the access keys for the specified web service. |
Method Details
beginCreateOrUpdate(string, string, WebService, WebServicesCreateOrUpdateOptionalParams)
Create or update a web service. This call will overwrite an existing web service. Note that there is no warning or confirmation. This is a nonrecoverable operation. If your intent is to create a new web service, call the Get operation first to verify that it does not exist.
function beginCreateOrUpdate(resourceGroupName: string, webServiceName: string, createOrUpdatePayload: WebService, options?: WebServicesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<WebService>, WebService>>Parameters
- resourceGroupName
-
string
Name of the resource group in which the web service is located.
- webServiceName
-
string
The name of the web service.
- createOrUpdatePayload
- WebService
The payload that is used to create or update the web service.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<WebService>, WebService>>
beginCreateOrUpdateAndWait(string, string, WebService, WebServicesCreateOrUpdateOptionalParams)
Create or update a web service. This call will overwrite an existing web service. Note that there is no warning or confirmation. This is a nonrecoverable operation. If your intent is to create a new web service, call the Get operation first to verify that it does not exist.
function beginCreateOrUpdateAndWait(resourceGroupName: string, webServiceName: string, createOrUpdatePayload: WebService, options?: WebServicesCreateOrUpdateOptionalParams): Promise<WebService>Parameters
- resourceGroupName
-
string
Name of the resource group in which the web service is located.
- webServiceName
-
string
The name of the web service.
- createOrUpdatePayload
- WebService
The payload that is used to create or update the web service.
The options parameters.
Returns
Promise<WebService>
beginCreateRegionalProperties(string, string, string, WebServicesCreateRegionalPropertiesOptionalParams)
Creates an encrypted credentials parameter blob for the specified region. To get the web service from a region other than the region in which it has been created, you must first call Create Regional Web Services Properties to create a copy of the encrypted credential parameter blob in that region. You only need to do this before the first time that you get the web service in the new region.
function beginCreateRegionalProperties(resourceGroupName: string, webServiceName: string, region: string, options?: WebServicesCreateRegionalPropertiesOptionalParams): Promise<PollerLike<PollOperationState<AsyncOperationStatus>, AsyncOperationStatus>>Parameters
- resourceGroupName
-
string
Name of the resource group in which the web service is located.
- webServiceName
-
string
The name of the web service.
- region
-
string
The region for which encrypted credential parameters are created.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<AsyncOperationStatus>, AsyncOperationStatus>>
beginCreateRegionalPropertiesAndWait(string, string, string, WebServicesCreateRegionalPropertiesOptionalParams)
Creates an encrypted credentials parameter blob for the specified region. To get the web service from a region other than the region in which it has been created, you must first call Create Regional Web Services Properties to create a copy of the encrypted credential parameter blob in that region. You only need to do this before the first time that you get the web service in the new region.
function beginCreateRegionalPropertiesAndWait(resourceGroupName: string, webServiceName: string, region: string, options?: WebServicesCreateRegionalPropertiesOptionalParams): Promise<AsyncOperationStatus>Parameters
- resourceGroupName
-
string
Name of the resource group in which the web service is located.
- webServiceName
-
string
The name of the web service.
- region
-
string
The region for which encrypted credential parameters are created.
The options parameters.
Returns
Promise<AsyncOperationStatus>
beginPatch(string, string, PatchedWebService, WebServicesPatchOptionalParams)
Modifies an existing web service resource. The PATCH API call is an asynchronous operation. To determine whether it has completed successfully, you must perform a Get operation.
function beginPatch(resourceGroupName: string, webServiceName: string, patchPayload: PatchedWebService, options?: WebServicesPatchOptionalParams): Promise<PollerLike<PollOperationState<WebService>, WebService>>Parameters
- resourceGroupName
-
string
Name of the resource group in which the web service is located.
- webServiceName
-
string
The name of the web service.
- patchPayload
- PatchedWebService
The payload to use to patch the web service.
- options
- WebServicesPatchOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<WebService>, WebService>>
beginPatchAndWait(string, string, PatchedWebService, WebServicesPatchOptionalParams)
Modifies an existing web service resource. The PATCH API call is an asynchronous operation. To determine whether it has completed successfully, you must perform a Get operation.
function beginPatchAndWait(resourceGroupName: string, webServiceName: string, patchPayload: PatchedWebService, options?: WebServicesPatchOptionalParams): Promise<WebService>Parameters
- resourceGroupName
-
string
Name of the resource group in which the web service is located.
- webServiceName
-
string
The name of the web service.
- patchPayload
- PatchedWebService
The payload to use to patch the web service.
- options
- WebServicesPatchOptionalParams
The options parameters.
Returns
Promise<WebService>
beginRemove(string, string, WebServicesRemoveOptionalParams)
Deletes the specified web service.
function beginRemove(resourceGroupName: string, webServiceName: string, options?: WebServicesRemoveOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
Name of the resource group in which the web service is located.
- webServiceName
-
string
The name of the web service.
- options
- WebServicesRemoveOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRemoveAndWait(string, string, WebServicesRemoveOptionalParams)
Deletes the specified web service.
function beginRemoveAndWait(resourceGroupName: string, webServiceName: string, options?: WebServicesRemoveOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group in which the web service is located.
- webServiceName
-
string
The name of the web service.
- options
- WebServicesRemoveOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, WebServicesGetOptionalParams)
Gets the Web Service Definition as specified by a subscription, resource group, and name. Note that the storage credentials and web service keys are not returned by this call. To get the web service access keys, call List Keys.
function get(resourceGroupName: string, webServiceName: string, options?: WebServicesGetOptionalParams): Promise<WebService>Parameters
- resourceGroupName
-
string
Name of the resource group in which the web service is located.
- webServiceName
-
string
The name of the web service.
- options
- WebServicesGetOptionalParams
The options parameters.
Returns
Promise<WebService>
listByResourceGroup(string, WebServicesListByResourceGroupOptionalParams)
Gets the web services in the specified resource group.
function listByResourceGroup(resourceGroupName: string, options?: WebServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<WebService, WebService[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group in which the web service is located.
The options parameters.
Returns
listBySubscriptionId(WebServicesListBySubscriptionIdOptionalParams)
Gets the web services in the specified subscription.
function listBySubscriptionId(options?: WebServicesListBySubscriptionIdOptionalParams): PagedAsyncIterableIterator<WebService, WebService[], PageSettings>Parameters
The options parameters.
Returns
listKeys(string, string, WebServicesListKeysOptionalParams)
Gets the access keys for the specified web service.
function listKeys(resourceGroupName: string, webServiceName: string, options?: WebServicesListKeysOptionalParams): Promise<WebServiceKeys>Parameters
- resourceGroupName
-
string
Name of the resource group in which the web service is located.
- webServiceName
-
string
The name of the web service.
The options parameters.
Returns
Promise<WebServiceKeys>