你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
WebSiteManagementClient class
- Extends
构造函数
属性
继承属性
| pipeline | 此客户端用于发出请求的管道 |
方法
继承的方法
| send |
发送使用提供的 OperationSpec 填充的 HTTP 请求。 |
| send |
发送提供的 httpRequest。 |
构造函数详细信息
WebSiteManagementClient(TokenCredential, string, WebSiteManagementClientOptionalParams)
初始化 WebSiteManagementClient 类的新实例。
new WebSiteManagementClient(credentials: TokenCredential, subscriptionId: string, options?: WebSiteManagementClientOptionalParams)参数
- credentials
- TokenCredential
唯一标识客户端订阅的订阅凭据。
- subscriptionId
-
string
Azure 订阅 ID。 这是 GUID 格式的字符串 (例如 00000000-0000-0000-0000-0000-0000000000000) 。
参数选项
WebSiteManagementClient(TokenCredential, WebSiteManagementClientOptionalParams)
new WebSiteManagementClient(credentials: TokenCredential, options?: WebSiteManagementClientOptionalParams)参数
- credentials
- TokenCredential
属性详细信息
$host
$host: string属性值
string
apiVersion
apiVersion: string属性值
string
appServiceCertificateOrders
appServiceEnvironments
appServicePlans
certificateOrdersDiagnostics
certificateRegistrationProvider
certificateRegistrationProvider: CertificateRegistrationProvider属性值
certificates
containerApps
containerAppsRevisions
deletedWebApps
diagnostics
domainRegistrationProvider
domains
getUsagesInLocation
global
kubeEnvironments
provider
recommendations
resourceHealthMetadataOperations
resourceHealthMetadataOperations: ResourceHealthMetadataOperations属性值
staticSites
subscriptionId
subscriptionId?: string属性值
string
topLevelDomains
webApps
workflowRunActionRepetitions
workflowRunActionRepetitionsRequestHistories
workflowRunActionRepetitionsRequestHistories: WorkflowRunActionRepetitionsRequestHistories属性值
workflowRunActions
workflowRunActionScopeRepetitions
workflowRunActionScopeRepetitions: WorkflowRunActionScopeRepetitions属性值
workflowRuns
workflows
workflowTriggerHistories
workflowTriggers
workflowVersions
继承属性详细信息
pipeline
方法详细信息
checkNameAvailability(string, string, CheckNameAvailabilityOptionalParams)
检查资源名称是否可用的说明。
function checkNameAvailability(name: string, typeParam: string, options?: CheckNameAvailabilityOptionalParams): Promise<ResourceNameAvailability>参数
- name
-
string
要验证的资源名称。
- typeParam
-
string
用于验证的资源类型。
选项参数。
返回
Promise<ResourceNameAvailability>
getPublishingUser(GetPublishingUserOptionalParams)
获取发布用户的说明
function getPublishingUser(options?: GetPublishingUserOptionalParams): Promise<User>参数
- options
- GetPublishingUserOptionalParams
选项参数。
返回
Promise<User>
getSourceControl(string, GetSourceControlOptionalParams)
获取源代码管理令牌的说明
function getSourceControl(sourceControlType: string, options?: GetSourceControlOptionalParams): Promise<SourceControl>参数
- sourceControlType
-
string
源代码管理的类型
- options
- GetSourceControlOptionalParams
选项参数。
返回
Promise<SourceControl>
getSubscriptionDeploymentLocations(GetSubscriptionDeploymentLocationsOptionalParams)
获取可用地理区域列表以及微型采样的说明
function getSubscriptionDeploymentLocations(options?: GetSubscriptionDeploymentLocationsOptionalParams): Promise<DeploymentLocations>参数
选项参数。
返回
Promise<DeploymentLocations>
listAseRegions(ListAseRegionsOptionalParams)
有关获取可用 ASE 区域及其支持的 SKU 的列表的说明。
function listAseRegions(options?: ListAseRegionsOptionalParams): PagedAsyncIterableIterator<AseRegion, AseRegion[], PageSettings>参数
- options
- ListAseRegionsOptionalParams
选项参数。
返回
listBillingMeters(ListBillingMetersOptionalParams)
获取给定位置的计量列表的说明。
function listBillingMeters(options?: ListBillingMetersOptionalParams): PagedAsyncIterableIterator<BillingMeter, BillingMeter[], PageSettings>参数
- options
- ListBillingMetersOptionalParams
选项参数。
返回
listCustomHostNameSites(ListCustomHostNameSitesOptionalParams)
获取此订阅下的自定义主机名
function listCustomHostNameSites(options?: ListCustomHostNameSitesOptionalParams): PagedAsyncIterableIterator<CustomHostnameSites, CustomHostnameSites[], PageSettings>参数
选项参数。
返回
listGeoRegions(ListGeoRegionsOptionalParams)
获取可用地理区域列表的说明。
function listGeoRegions(options?: ListGeoRegionsOptionalParams): PagedAsyncIterableIterator<GeoRegion, GeoRegion[], PageSettings>参数
- options
- ListGeoRegionsOptionalParams
选项参数。
返回
listPremierAddOnOffers(ListPremierAddOnOffersOptionalParams)
列出所有高级加载项产品/服务的说明。
function listPremierAddOnOffers(options?: ListPremierAddOnOffersOptionalParams): PagedAsyncIterableIterator<PremierAddOnOffer, PremierAddOnOffer[], PageSettings>参数
选项参数。
返回
listSiteIdentifiersAssignedToHostName(NameIdentifier, ListSiteIdentifiersAssignedToHostNameOptionalParams)
列出分配给主机名的所有应用的说明。
function listSiteIdentifiersAssignedToHostName(nameIdentifier: NameIdentifier, options?: ListSiteIdentifiersAssignedToHostNameOptionalParams): PagedAsyncIterableIterator<Identifier, Identifier[], PageSettings>参数
- nameIdentifier
- NameIdentifier
主机名信息。
选项参数。
返回
listSkus(ListSkusOptionalParams)
列出所有 SKU 的说明。
function listSkus(options?: ListSkusOptionalParams): Promise<SkuInfos>参数
- options
- ListSkusOptionalParams
选项参数。
返回
Promise<SkuInfos>
listSourceControls(ListSourceControlsOptionalParams)
获取可用于 Azure 网站的源代码管理的说明。
function listSourceControls(options?: ListSourceControlsOptionalParams): PagedAsyncIterableIterator<SourceControl, SourceControl[], PageSettings>参数
- options
- ListSourceControlsOptionalParams
选项参数。
返回
move(string, CsmMoveResourceEnvelope, MoveOptionalParams)
在资源组之间移动资源的说明。
function move(resourceGroupName: string, moveResourceEnvelope: CsmMoveResourceEnvelope, options?: MoveOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- moveResourceEnvelope
- CsmMoveResourceEnvelope
表示要移动的资源的对象。
- options
- MoveOptionalParams
选项参数。
返回
Promise<void>
updatePublishingUser(User, UpdatePublishingUserOptionalParams)
汇报发布用户的说明
function updatePublishingUser(userDetails: User, options?: UpdatePublishingUserOptionalParams): Promise<User>参数
- userDetails
- User
发布用户的详细信息
选项参数。
返回
Promise<User>
updateSourceControl(string, SourceControl, UpdateSourceControlOptionalParams)
汇报源代码管理令牌的说明
function updateSourceControl(sourceControlType: string, requestMessage: SourceControl, options?: UpdateSourceControlOptionalParams): Promise<SourceControl>参数
- sourceControlType
-
string
源代码管理的类型
- requestMessage
- SourceControl
源代码管理令牌信息
选项参数。
返回
Promise<SourceControl>
validate(string, ValidateRequest, ValidateOptionalParams)
验证是否可以创建资源的说明。
function validate(resourceGroupName: string, validateRequest: ValidateRequest, options?: ValidateOptionalParams): Promise<ValidateResponse>参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- validateRequest
- ValidateRequest
请求包含要验证的资源。
- options
- ValidateOptionalParams
选项参数。
返回
Promise<ValidateResponse>
validateMove(string, CsmMoveResourceEnvelope, ValidateMoveOptionalParams)
验证资源是否可以移动的说明。
function validateMove(resourceGroupName: string, moveResourceEnvelope: CsmMoveResourceEnvelope, options?: ValidateMoveOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- moveResourceEnvelope
- CsmMoveResourceEnvelope
表示要移动的资源的对象。
- options
- ValidateMoveOptionalParams
选项参数。
返回
Promise<void>
verifyHostingEnvironmentVnet(VnetParameters, VerifyHostingEnvironmentVnetOptionalParams)
说明通过分析网络安全组规则来验证此 VNET 是否与应用服务环境兼容。
function verifyHostingEnvironmentVnet(parameters: VnetParameters, options?: VerifyHostingEnvironmentVnetOptionalParams): Promise<VnetValidationFailureDetails>参数
- parameters
- VnetParameters
VNET 信息
选项参数。
返回
Promise<VnetValidationFailureDetails>
继承的方法详细信息
sendOperationRequest<T>(OperationArguments, OperationSpec)
发送使用提供的 OperationSpec 填充的 HTTP 请求。
function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>参数
- operationArguments
- OperationArguments
将从中填充 HTTP 请求的模板化值的参数。
- operationSpec
- OperationSpec
用于填充 httpRequest 的 OperationSpec。
返回
Promise<T>
继承自 coreClient.ServiceClient.sendOperationRequest
sendRequest(PipelineRequest)
发送提供的 httpRequest。
function sendRequest(request: PipelineRequest): Promise<PipelineResponse>参数
- request
- PipelineRequest
返回
Promise<PipelineResponse>
继承自 coreClient.ServiceClient.sendRequest