WebServices | @azure/arm-webservices

Class representing a WebServices.

Hierarchy

WebServices

Index

Constructors

constructor

Methods

Constructors

constructor

new WebServices(client: AzureMLWebServicesManagementClientContext): WebServices

- Defined in operations/webServices.ts:20
Create a WebServices.

Parameters
- client: AzureMLWebServicesManagementClientContext
  
  Reference to the service client.
Returns WebServices

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, webServiceName: string, createOrUpdatePayload: WebService, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/webServices.ts:216
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.

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.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginCreateRegionalProperties

beginCreateRegionalProperties(resourceGroupName: string, webServiceName: string, region: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/webServices.ts:279
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.

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.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginPatch

beginPatch(resourceGroupName: string, webServiceName: string, patchPayload: WebService, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/webServices.ts:237
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.

Parameters
- resourceGroupName: string
  
  Name of the resource group in which the web service is located.
- webServiceName: string
  
  The name of the web service.
- patchPayload: WebService
  
  The payload to use to patch the web service.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginRemove

beginRemove(resourceGroupName: string, webServiceName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/webServices.ts:256
Deletes the specified web service.

Parameters
- resourceGroupName: string
  
  Name of the resource group in which the web service is located.
- webServiceName: string
  
  The name of the web service.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

createOrUpdate

createOrUpdate(resourceGroupName: string, webServiceName: string, createOrUpdatePayload: WebService, options?: msRest.RequestOptionsBase): Promise<Models.WebServicesCreateOrUpdateResponse>

- Defined in operations/webServices.ts:40
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.

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.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.WebServicesCreateOrUpdateResponse>

Promise<Models.WebServicesCreateOrUpdateResponse>

createRegionalProperties

createRegionalProperties(resourceGroupName: string, webServiceName: string, region: string, options?: msRest.RequestOptionsBase): Promise<Models.WebServicesCreateRegionalPropertiesResponse>

- Defined in operations/webServices.ts:117
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.

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.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.WebServicesCreateRegionalPropertiesResponse>

Promise<Models.WebServicesCreateRegionalPropertiesResponse>

get

get(resourceGroupName: string, webServiceName: string, options?: Models.WebServicesGetOptionalParams): Promise<Models.WebServicesGetResponse>
get(resourceGroupName: string, webServiceName: string, callback: msRest.ServiceCallback<WebService>): void
get(resourceGroupName: string, webServiceName: string, options: WebServicesGetOptionalParams, callback: msRest.ServiceCallback<WebService>): void

- Defined in operations/webServices.ts:54
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.

Parameters
- resourceGroupName: string
  
  Name of the resource group in which the web service is located.
- webServiceName: string
  
  The name of the web service.
- Optional options: Models.WebServicesGetOptionalParams
Returns Promise<Models.WebServicesGetResponse>

Promise<Models.WebServicesGetResponse>
- Defined in operations/webServices.ts:60
Parameters
- resourceGroupName: string
  
  Name of the resource group in which the web service is located.
- webServiceName: string
  
  The name of the web service.
- callback: msRest.ServiceCallback<WebService>
  
  The callback
Returns void
- Defined in operations/webServices.ts:67
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 optional parameters
- callback: msRest.ServiceCallback<WebService>
  
  The callback
Returns void

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: Models.WebServicesListByResourceGroupOptionalParams): Promise<Models.WebServicesListByResourceGroupResponse>
listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<PaginatedWebServicesList>): void
listByResourceGroup(resourceGroupName: string, options: WebServicesListByResourceGroupOptionalParams, callback: msRest.ServiceCallback<PaginatedWebServicesList>): void

- Defined in operations/webServices.ts:160
Gets the web services in the specified resource group.

Parameters
- resourceGroupName: string
  
  Name of the resource group in which the web service is located.
- Optional options: Models.WebServicesListByResourceGroupOptionalParams
Returns Promise<Models.WebServicesListByResourceGroupResponse>

Promise<Models.WebServicesListByResourceGroupResponse>
- Defined in operations/webServices.ts:165
Parameters
- resourceGroupName: string
  
  Name of the resource group in which the web service is located.
- callback: msRest.ServiceCallback<PaginatedWebServicesList>
  
  The callback
Returns void
- Defined in operations/webServices.ts:171
Parameters
- resourceGroupName: string
  
  Name of the resource group in which the web service is located.
- options: WebServicesListByResourceGroupOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<PaginatedWebServicesList>
  
  The callback
Returns void

listByResourceGroupNext

listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.WebServicesListByResourceGroupNextResponse>
listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<PaginatedWebServicesList>): void
listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PaginatedWebServicesList>): void

- Defined in operations/webServices.ts:297
Gets the web services in the specified resource group.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.WebServicesListByResourceGroupNextResponse>

Promise<Models.WebServicesListByResourceGroupNextResponse>
- Defined in operations/webServices.ts:302
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<PaginatedWebServicesList>
  
  The callback
Returns void
- Defined in operations/webServices.ts:308
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<PaginatedWebServicesList>
  
  The callback
Returns void

listBySubscriptionId

listBySubscriptionId(options?: Models.WebServicesListBySubscriptionIdOptionalParams): Promise<Models.WebServicesListBySubscriptionIdResponse>
listBySubscriptionId(callback: msRest.ServiceCallback<PaginatedWebServicesList>): void
listBySubscriptionId(options: WebServicesListBySubscriptionIdOptionalParams, callback: msRest.ServiceCallback<PaginatedWebServicesList>): void

- Defined in operations/webServices.ts:187
Gets the web services in the specified subscription.

Parameters
- Optional options: Models.WebServicesListBySubscriptionIdOptionalParams
Returns Promise<Models.WebServicesListBySubscriptionIdResponse>

Promise<Models.WebServicesListBySubscriptionIdResponse>
- Defined in operations/webServices.ts:191
Parameters
- callback: msRest.ServiceCallback<PaginatedWebServicesList>
  
  The callback
Returns void
- Defined in operations/webServices.ts:196
Parameters
- options: WebServicesListBySubscriptionIdOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<PaginatedWebServicesList>
  
  The callback
Returns void

listBySubscriptionIdNext

listBySubscriptionIdNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.WebServicesListBySubscriptionIdNextResponse>
listBySubscriptionIdNext(nextPageLink: string, callback: msRest.ServiceCallback<PaginatedWebServicesList>): void
listBySubscriptionIdNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PaginatedWebServicesList>): void

- Defined in operations/webServices.ts:325
Gets the web services in the specified subscription.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.WebServicesListBySubscriptionIdNextResponse>

Promise<Models.WebServicesListBySubscriptionIdNextResponse>
- Defined in operations/webServices.ts:330
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<PaginatedWebServicesList>
  
  The callback
Returns void
- Defined in operations/webServices.ts:336
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<PaginatedWebServicesList>
  
  The callback
Returns void

listKeys

listKeys(resourceGroupName: string, webServiceName: string, options?: msRest.RequestOptionsBase): Promise<Models.WebServicesListKeysResponse>
listKeys(resourceGroupName: string, webServiceName: string, callback: msRest.ServiceCallback<WebServiceKeys>): void
listKeys(resourceGroupName: string, webServiceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<WebServiceKeys>): void

- Defined in operations/webServices.ts:129
Gets the access keys for the specified web service.

Parameters
- resourceGroupName: string
  
  Name of the resource group in which the web service is located.
- webServiceName: string
  
  The name of the web service.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.WebServicesListKeysResponse>

Promise<Models.WebServicesListKeysResponse>
- Defined in operations/webServices.ts:135
Parameters
- resourceGroupName: string
  
  Name of the resource group in which the web service is located.
- webServiceName: string
  
  The name of the web service.
- callback: msRest.ServiceCallback<WebServiceKeys>
  
  The callback
Returns void
- Defined in operations/webServices.ts:142
Parameters
- resourceGroupName: string
  
  Name of the resource group in which the web service is located.
- webServiceName: string
  
  The name of the web service.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<WebServiceKeys>
  
  The callback
Returns void

patch

patch(resourceGroupName: string, webServiceName: string, patchPayload: WebService, options?: msRest.RequestOptionsBase): Promise<Models.WebServicesPatchResponse>

- Defined in operations/webServices.ts:88
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.

Parameters
- resourceGroupName: string
  
  Name of the resource group in which the web service is located.
- webServiceName: string
  
  The name of the web service.
- patchPayload: WebService
  
  The payload to use to patch the web service.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.WebServicesPatchResponse>

Promise<Models.WebServicesPatchResponse>

remove

remove(resourceGroupName: string, webServiceName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/webServices.ts:100
Deletes the specified web service.

Parameters
- resourceGroupName: string
  
  Name of the resource group in which the web service is located.
- webServiceName: string
  
  The name of the web service.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: AzureMLWebServicesManagementClientContext

Returns WebServices

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

webServiceName: string

createOrUpdatePayload: WebService

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginCreateRegionalProperties

Parameters

resourceGroupName: string

webServiceName: string

region: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginPatch

Parameters

resourceGroupName: string

webServiceName: string

patchPayload: WebService

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginRemove

Parameters

resourceGroupName: string

webServiceName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

createOrUpdate

Parameters

resourceGroupName: string

webServiceName: string

createOrUpdatePayload: WebService

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.WebServicesCreateOrUpdateResponse>

createRegionalProperties

Parameters

resourceGroupName: string

webServiceName: string

region: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.WebServicesCreateRegionalPropertiesResponse>

get

Parameters

resourceGroupName: string

webServiceName: string

Optional options: Models.WebServicesGetOptionalParams

Returns Promise<Models.WebServicesGetResponse>

Parameters

resourceGroupName: string

webServiceName: string

callback: msRest.ServiceCallback<WebService>

Returns void

Parameters

resourceGroupName: string

webServiceName: string

options: WebServicesGetOptionalParams

callback: msRest.ServiceCallback<WebService>

Returns void

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: Models.WebServicesListByResourceGroupOptionalParams

Returns Promise<Models.WebServicesListByResourceGroupResponse>

Parameters

resourceGroupName: string

callback: msRest.ServiceCallback<PaginatedWebServicesList>

Returns void

Parameters

resourceGroupName: string

options: WebServicesListByResourceGroupOptionalParams