ApiManagementClient class

套件:

@azure/arm-apimanagement

Extends

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

目標訂用帳戶的識別碼。

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