你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ApiManagementClient class

包:

@azure/arm-apimanagement

扩展

ServiceClient

构造函数

ApiManagementClient(TokenCredential, ApiManagementClientOptionalParams)
ApiManagementClient(TokenCredential, string, ApiManagementClientOptionalParams)	初始化 ApiManagementClient 类的新实例。

属性

$host
api
apiDiagnostic
apiExport
apiIssue
apiIssueAttachment
apiIssueComment
apiManagementOperations
apiManagementService
apiManagementServiceSkus
apiManagementSkus
apiOperation
apiOperationPolicy
apiPolicy
apiProduct
apiRelease
apiRevision
apiSchema
apiTagDescription
apiVersion
apiVersionSet
apiWiki
apiWikis
authorization
authorizationAccessPolicy
authorizationLoginLinks
authorizationProvider
authorizationServer
backend
cache
certificate
contentItem
contentType
delegationSettings
deletedServices
diagnostic
documentation
emailTemplate
gateway
gatewayApi
gatewayCertificateAuthority
gatewayHostnameConfiguration
globalSchema
graphQLApiResolver
graphQLApiResolverPolicy
group
groupUser
identityProvider
issue
logger
namedValue
networkStatus
notification
notificationRecipientEmail
notificationRecipientUser
openIdConnectProvider
operationOperations
outboundNetworkDependenciesEndpoints
policy
policyDescription
policyFragment
portalConfig
portalRevision
portalSettings
privateEndpointConnectionOperations
product
productApi
productGroup
productPolicy
productSubscriptions
productWiki
productWikis
quotaByCounterKeys
quotaByPeriodKeys
region
reports
signInSettings
signUpSettings
subscription
subscriptionId
tag
tagResource
tenantAccess
tenantAccessGit
tenantConfiguration
tenantSettings
user
userConfirmationPassword
userGroup
userIdentities
userSubscription

继承属性

pipeline

此客户端用于发出请求的管道

方法

beginPerformConnectivityCheckAsync(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)	在 API 管理服务和给定目标之间执行连接检查，并返回连接的指标，以及尝试建立连接时遇到的错误。
beginPerformConnectivityCheckAsyncAndWait(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)	在 API 管理服务和给定目标之间执行连接检查，并返回连接的指标，以及尝试建立连接时遇到的错误。

继承的方法

sendOperationRequest<T>(OperationArguments, OperationSpec)	发送使用提供的 OperationSpec 填充的 HTTP 请求。
sendRequest(PipelineRequest)	发送提供的 httpRequest。

构造函数详细信息

ApiManagementClient(TokenCredential, ApiManagementClientOptionalParams)

new ApiManagementClient(credentials: TokenCredential, options?: ApiManagementClientOptionalParams)

参数

credentials

TokenCredential

options

ApiManagementClientOptionalParams

ApiManagementClient(TokenCredential, string, ApiManagementClientOptionalParams)

初始化 ApiManagementClient 类的新实例。

new ApiManagementClient(credentials: TokenCredential, subscriptionId: string, options?: ApiManagementClientOptionalParams)

参数

credentials

TokenCredential

唯一标识客户端订阅的订阅凭据。

subscriptionId

string

目标订阅的 ID。

options

ApiManagementClientOptionalParams

参数选项

属性详细信息

$host

$host: string

属性值

string

api

api: Api

属性值

Api

apiDiagnostic

apiDiagnostic: ApiDiagnostic

属性值

ApiDiagnostic

apiExport

apiExport: ApiExport

属性值

ApiExport

apiIssue

apiIssue: ApiIssue

属性值

ApiIssue

apiIssueAttachment

apiIssueAttachment: ApiIssueAttachment

属性值

ApiIssueAttachment

apiIssueComment

apiIssueComment: ApiIssueComment

属性值

ApiIssueComment

apiManagementOperations

apiManagementOperations: ApiManagementOperations

属性值

ApiManagementOperations

apiManagementService

apiManagementService: ApiManagementService

属性值

ApiManagementService

apiManagementServiceSkus

apiManagementServiceSkus: ApiManagementServiceSkus

属性值

ApiManagementServiceSkus

apiManagementSkus

apiManagementSkus: ApiManagementSkus

属性值

ApiManagementSkus

apiOperation

apiOperation: ApiOperation

属性值

ApiOperation

apiOperationPolicy

apiOperationPolicy: ApiOperationPolicy

属性值

ApiOperationPolicy

apiPolicy

apiPolicy: ApiPolicy

属性值

ApiPolicy

apiProduct

apiProduct: ApiProduct

属性值

ApiProduct

apiRelease

apiRelease: ApiRelease

属性值

ApiRelease

apiRevision

apiRevision: ApiRevision

属性值

ApiRevision

apiSchema

apiSchema: ApiSchema

属性值

ApiSchema

apiTagDescription

apiTagDescription: ApiTagDescription

属性值

ApiTagDescription

apiVersion

apiVersion: string

属性值

string

apiVersionSet

apiVersionSet: ApiVersionSet

属性值

ApiVersionSet

apiWiki

apiWiki: ApiWiki

属性值

ApiWiki

apiWikis

apiWikis: ApiWikis

属性值

ApiWikis

authorization

authorization: Authorization

属性值

Authorization

authorizationAccessPolicy

authorizationAccessPolicy: AuthorizationAccessPolicy

属性值

AuthorizationAccessPolicy

authorizationLoginLinks

authorizationLoginLinks: AuthorizationLoginLinks

属性值

AuthorizationLoginLinks

authorizationProvider

authorizationProvider: AuthorizationProvider

属性值

AuthorizationProvider

authorizationServer

authorizationServer: AuthorizationServer

属性值

AuthorizationServer

backend

backend: Backend

属性值

Backend

cache

cache: Cache_2

属性值

Cache

certificate

certificate: Certificate

属性值

Certificate

contentItem

contentItem: ContentItem

属性值

ContentItem

contentType

contentType: ContentType

属性值

ContentType

delegationSettings

delegationSettings: DelegationSettings

属性值

DelegationSettings

deletedServices

deletedServices: DeletedServices

属性值

DeletedServices

diagnostic

diagnostic: Diagnostic

属性值

Diagnostic

documentation

documentation: Documentation

属性值

Documentation

emailTemplate

emailTemplate: EmailTemplate

属性值

EmailTemplate

gateway

gateway: Gateway

属性值

Gateway

gatewayApi

gatewayApi: GatewayApi

属性值

GatewayApi

gatewayCertificateAuthority

gatewayCertificateAuthority: GatewayCertificateAuthority

属性值

GatewayCertificateAuthority

gatewayHostnameConfiguration

gatewayHostnameConfiguration: GatewayHostnameConfiguration

属性值

GatewayHostnameConfiguration

globalSchema

globalSchema: GlobalSchema

属性值

GlobalSchema

graphQLApiResolver

graphQLApiResolver: GraphQLApiResolver

属性值

GraphQLApiResolver

graphQLApiResolverPolicy

graphQLApiResolverPolicy: GraphQLApiResolverPolicy

属性值

GraphQLApiResolverPolicy

group

group: Group

属性值

Group

groupUser

groupUser: GroupUser

属性值

GroupUser

identityProvider

identityProvider: IdentityProvider

属性值

IdentityProvider

issue

issue: Issue

属性值

Issue

logger

logger: Logger

属性值

Logger

namedValue

namedValue: NamedValue

属性值

NamedValue

networkStatus

networkStatus: NetworkStatus

属性值

NetworkStatus

notification

notification: Notification_2

属性值

Notification

notificationRecipientEmail

notificationRecipientEmail: NotificationRecipientEmail

属性值

NotificationRecipientEmail

notificationRecipientUser

notificationRecipientUser: NotificationRecipientUser

属性值

NotificationRecipientUser

openIdConnectProvider

openIdConnectProvider: OpenIdConnectProvider

属性值

OpenIdConnectProvider

operationOperations

operationOperations: OperationOperations

属性值

OperationOperations

outboundNetworkDependenciesEndpoints

outboundNetworkDependenciesEndpoints: OutboundNetworkDependenciesEndpoints

属性值

OutboundNetworkDependenciesEndpoints

policy

policy: Policy

属性值

Policy

policyDescription

policyDescription: PolicyDescription

属性值

PolicyDescription

policyFragment

policyFragment: PolicyFragment

属性值

PolicyFragment

portalConfig

portalConfig: PortalConfig

属性值

PortalConfig

portalRevision

portalRevision: PortalRevision

属性值

PortalRevision

portalSettings

portalSettings: PortalSettings

属性值

PortalSettings

privateEndpointConnectionOperations

privateEndpointConnectionOperations: PrivateEndpointConnectionOperations

属性值

PrivateEndpointConnectionOperations

product

product: Product

属性值

Product

productApi

productApi: ProductApi

属性值

ProductApi

productGroup

productGroup: ProductGroup

属性值

ProductGroup

productPolicy

productPolicy: ProductPolicy

属性值

ProductPolicy

productSubscriptions

productSubscriptions: ProductSubscriptions

属性值

ProductSubscriptions

productWiki

productWiki: ProductWiki

属性值

ProductWiki

productWikis

productWikis: ProductWikis

属性值

ProductWikis

quotaByCounterKeys

quotaByCounterKeys: QuotaByCounterKeys

属性值

QuotaByCounterKeys

quotaByPeriodKeys

quotaByPeriodKeys: QuotaByPeriodKeys

属性值

QuotaByPeriodKeys

region

region: Region

属性值

Region

reports

reports: Reports

属性值

Reports

signInSettings

signInSettings: SignInSettings

属性值

SignInSettings

signUpSettings

signUpSettings: SignUpSettings

属性值

SignUpSettings

subscription

subscription: Subscription

属性值

Subscription

subscriptionId

subscriptionId?: string

属性值

string

tag

tag: Tag

属性值

Tag

tagResource

tagResource: TagResource

属性值

TagResource

tenantAccess

tenantAccess: TenantAccess

属性值

TenantAccess

tenantAccessGit

tenantAccessGit: TenantAccessGit

属性值

TenantAccessGit

tenantConfiguration

tenantConfiguration: TenantConfiguration

属性值

TenantConfiguration

tenantSettings

tenantSettings: TenantSettings

属性值

TenantSettings

user

user: User

属性值

User

userConfirmationPassword

userConfirmationPassword: UserConfirmationPassword

属性值

UserConfirmationPassword

userGroup

userGroup: UserGroup

属性值

UserGroup

userIdentities

userIdentities: UserIdentities

属性值

UserIdentities

userSubscription

userSubscription: UserSubscription

属性值

UserSubscription

继承属性详细信息

pipeline

此客户端用于发出请求的管道

pipeline: Pipeline

属性值

Pipeline

继承自 coreClient.ServiceClient.pipeline

方法详细信息

beginPerformConnectivityCheckAsync(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

在 API 管理服务和给定目标之间执行连接检查，并返回连接的指标，以及尝试建立连接时遇到的错误。

function beginPerformConnectivityCheckAsync(resourceGroupName: string, serviceName: string, connectivityCheckRequestParams: ConnectivityCheckRequest, options?: PerformConnectivityCheckAsyncOptionalParams): Promise<SimplePollerLike<OperationState<ConnectivityCheckResponse>, ConnectivityCheckResponse>>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

connectivityCheckRequestParams

ConnectivityCheckRequest

连接检查请求参数。

options

PerformConnectivityCheckAsyncOptionalParams

选项参数。

返回

Promise<@azure/core-lro.SimplePollerLike<OperationState<ConnectivityCheckResponse>, ConnectivityCheckResponse>>

beginPerformConnectivityCheckAsyncAndWait(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

在 API 管理服务和给定目标之间执行连接检查，并返回连接的指标，以及尝试建立连接时遇到的错误。

function beginPerformConnectivityCheckAsyncAndWait(resourceGroupName: string, serviceName: string, connectivityCheckRequestParams: ConnectivityCheckRequest, options?: PerformConnectivityCheckAsyncOptionalParams): Promise<ConnectivityCheckResponse>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

serviceName

string

API 管理服务的名称。

connectivityCheckRequestParams

ConnectivityCheckRequest

连接检查请求参数。

options

PerformConnectivityCheckAsyncOptionalParams

选项参数。

返回

Promise<ConnectivityCheckResponse>

继承的方法详细信息

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