WebSiteManagementClient class
- Extends
Constructors
| Web |
Initializes a new instance of the WebSiteManagementClient class. |
Properties
| $host | |
| api |
|
| app |
|
| certificates | |
| provider | |
| recommendations | |
| subscription |
|
| web |
Inherited Properties
| pipeline | The pipeline used by this client to make requests |
Methods
Inherited Methods
| send |
Send an HTTP request that is populated using the provided OperationSpec. |
| send |
Send the provided httpRequest. |
Constructor Details
WebSiteManagementClient(TokenCredential, string, WebSiteManagementClientOptionalParams)
Initializes a new instance of the WebSiteManagementClient class.
new WebSiteManagementClient(credentials: TokenCredential, subscriptionId: string, options?: WebSiteManagementClientOptionalParams)Parameters
- credentials
- TokenCredential
Subscription credentials which uniquely identify client subscription.
- subscriptionId
-
string
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
The parameter options
Property Details
$host
$host: stringProperty Value
string
apiVersion
apiVersion: stringProperty Value
string
appServicePlans
certificates
provider
recommendations
subscriptionId
subscriptionId: stringProperty Value
string
webApps
Inherited Property Details
pipeline
The pipeline used by this client to make requests
pipeline: PipelineProperty Value
Inherited From coreClient.ServiceClient.pipeline
Method Details
checkNameAvailability(string, string, CheckNameAvailabilityOptionalParams)
Check if a resource name is available.
function checkNameAvailability(name: string, typeParam: string, options?: CheckNameAvailabilityOptionalParams): Promise<ResourceNameAvailability>Parameters
- name
-
string
Resource name to verify.
- typeParam
-
string
Resource type used for verification.
The options parameters.
Returns
Promise<ResourceNameAvailability>
getPublishingUser(GetPublishingUserOptionalParams)
Gets publishing user
function getPublishingUser(options?: GetPublishingUserOptionalParams): Promise<User>Parameters
- options
- GetPublishingUserOptionalParams
The options parameters.
Returns
Promise<User>
getSourceControl(string, GetSourceControlOptionalParams)
Gets source control token
function getSourceControl(sourceControlType: string, options?: GetSourceControlOptionalParams): Promise<SourceControl>Parameters
- sourceControlType
-
string
Type of source control
- options
- GetSourceControlOptionalParams
The options parameters.
Returns
Promise<SourceControl>
getSubscriptionDeploymentLocations(GetSubscriptionDeploymentLocationsOptionalParams)
Gets list of available geo regions plus ministamps
function getSubscriptionDeploymentLocations(options?: GetSubscriptionDeploymentLocationsOptionalParams): Promise<DeploymentLocations>Parameters
The options parameters.
Returns
Promise<DeploymentLocations>
listBillingMeters(ListBillingMetersOptionalParams)
Gets a list of meters for a given location.
function listBillingMeters(options?: ListBillingMetersOptionalParams): PagedAsyncIterableIterator<BillingMeter, BillingMeter[], PageSettings>Parameters
- options
- ListBillingMetersOptionalParams
The options parameters.
Returns
listGeoRegions(ListGeoRegionsOptionalParams)
Get a list of available geographical regions.
function listGeoRegions(options?: ListGeoRegionsOptionalParams): PagedAsyncIterableIterator<GeoRegion, GeoRegion[], PageSettings>Parameters
- options
- ListGeoRegionsOptionalParams
The options parameters.
Returns
listPremierAddOnOffers(ListPremierAddOnOffersOptionalParams)
List all premier add-on offers.
function listPremierAddOnOffers(options?: ListPremierAddOnOffersOptionalParams): PagedAsyncIterableIterator<PremierAddOnOffer, PremierAddOnOffer[], PageSettings>Parameters
The options parameters.
Returns
listSiteIdentifiersAssignedToHostName(NameIdentifier, ListSiteIdentifiersAssignedToHostNameOptionalParams)
List all apps that are assigned to a hostname.
function listSiteIdentifiersAssignedToHostName(nameIdentifier: NameIdentifier, options?: ListSiteIdentifiersAssignedToHostNameOptionalParams): PagedAsyncIterableIterator<Identifier, Identifier[], PageSettings>Parameters
- nameIdentifier
- NameIdentifier
Hostname information.
The options parameters.
Returns
listSkus(ListSkusOptionalParams)
List all SKUs.
function listSkus(options?: ListSkusOptionalParams): Promise<SkuInfos>Parameters
- options
- ListSkusOptionalParams
The options parameters.
Returns
Promise<SkuInfos>
listSourceControls(ListSourceControlsOptionalParams)
Gets the source controls available for Azure websites.
function listSourceControls(options?: ListSourceControlsOptionalParams): PagedAsyncIterableIterator<SourceControl, SourceControl[], PageSettings>Parameters
- options
- ListSourceControlsOptionalParams
The options parameters.
Returns
move(string, CsmMoveResourceEnvelope, MoveOptionalParams)
Move resources between resource groups.
function move(resourceGroupName: string, moveResourceEnvelope: CsmMoveResourceEnvelope, options?: MoveOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- moveResourceEnvelope
- CsmMoveResourceEnvelope
Object that represents the resource to move.
- options
- MoveOptionalParams
The options parameters.
Returns
Promise<void>
updatePublishingUser(User, UpdatePublishingUserOptionalParams)
Updates publishing user
function updatePublishingUser(userDetails: User, options?: UpdatePublishingUserOptionalParams): Promise<User>Parameters
- userDetails
- User
Details of publishing user
The options parameters.
Returns
Promise<User>
updateSourceControl(string, SourceControl, UpdateSourceControlOptionalParams)
Updates source control token
function updateSourceControl(sourceControlType: string, requestMessage: SourceControl, options?: UpdateSourceControlOptionalParams): Promise<SourceControl>Parameters
- sourceControlType
-
string
Type of source control
- requestMessage
- SourceControl
Source control token information
The options parameters.
Returns
Promise<SourceControl>
validate(string, ValidateRequest, ValidateOptionalParams)
Validate if a resource can be created.
function validate(resourceGroupName: string, validateRequest: ValidateRequest, options?: ValidateOptionalParams): Promise<ValidateResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- validateRequest
- ValidateRequest
Request with the resources to validate.
- options
- ValidateOptionalParams
The options parameters.
Returns
Promise<ValidateResponse>
validateContainerSettings(string, ValidateContainerSettingsRequest, ValidateContainerSettingsOptionalParams)
Validate if the container settings are correct.
function validateContainerSettings(resourceGroupName: string, validateContainerSettingsRequest: ValidateContainerSettingsRequest, options?: ValidateContainerSettingsOptionalParams): Promise<ValidateContainerSettingsResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- validateContainerSettingsRequest
- ValidateContainerSettingsRequest
Container settings validation request context
The options parameters.
Returns
Promise<ValidateContainerSettingsResponse>
validateMove(string, CsmMoveResourceEnvelope, ValidateMoveOptionalParams)
Validate whether a resource can be moved.
function validateMove(resourceGroupName: string, moveResourceEnvelope: CsmMoveResourceEnvelope, options?: ValidateMoveOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- moveResourceEnvelope
- CsmMoveResourceEnvelope
Object that represents the resource to move.
- options
- ValidateMoveOptionalParams
The options parameters.
Returns
Promise<void>
verifyHostingEnvironmentVnet(VnetParameters, VerifyHostingEnvironmentVnetOptionalParams)
Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules.
function verifyHostingEnvironmentVnet(parameters: VnetParameters, options?: VerifyHostingEnvironmentVnetOptionalParams): Promise<VnetValidationFailureDetails>Parameters
- parameters
- VnetParameters
VNET information
The options parameters.
Returns
Promise<VnetValidationFailureDetails>
Inherited Method Details
sendOperationRequest<T>(OperationArguments, OperationSpec)
Send an HTTP request that is populated using the provided OperationSpec.
function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>Parameters
- operationArguments
- OperationArguments
The arguments that the HTTP request's templated values will be populated from.
- operationSpec
- OperationSpec
The OperationSpec to use to populate the httpRequest.
Returns
Promise<T>
Inherited From coreClient.ServiceClient.sendOperationRequest
sendRequest(PipelineRequest)
Send the provided httpRequest.
function sendRequest(request: PipelineRequest): Promise<PipelineResponse>Parameters
- request
- PipelineRequest
Returns
Promise<PipelineResponse>
Inherited From coreClient.ServiceClient.sendRequest