Поделиться через


ApiManagementClient class

Extends

Конструкторы

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)

Отправьте HTTP-запрос, который заполняется с помощью предоставленного OperationSpec.

sendRequest(PipelineRequest)

Отправка предоставленного httpRequest.

Сведения о конструкторе

ApiManagementClient(TokenCredential, ApiManagementClientOptionalParams)

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

Параметры

credentials
TokenCredential

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

Значение свойства

apiExport

apiExport: ApiExport

Значение свойства

apiIssue

apiIssue: ApiIssue

Значение свойства

apiIssueAttachment

apiIssueAttachment: ApiIssueAttachment

Значение свойства

apiIssueComment

apiIssueComment: ApiIssueComment

Значение свойства

apiManagementOperations

apiManagementOperations: ApiManagementOperations

Значение свойства

apiManagementService

apiManagementService: ApiManagementService

Значение свойства

apiManagementServiceSkus

apiManagementServiceSkus: ApiManagementServiceSkus

Значение свойства

apiManagementSkus

apiManagementSkus: ApiManagementSkus

Значение свойства

apiOperation

apiOperation: ApiOperation

Значение свойства

apiOperationPolicy

apiOperationPolicy: ApiOperationPolicy

Значение свойства

apiPolicy

apiPolicy: ApiPolicy

Значение свойства

apiProduct

apiProduct: ApiProduct

Значение свойства

apiRelease

apiRelease: ApiRelease

Значение свойства

apiRevision

apiRevision: ApiRevision

Значение свойства

apiSchema

apiSchema: ApiSchema

Значение свойства

apiTagDescription

apiTagDescription: ApiTagDescription

Значение свойства

apiVersion

apiVersion: string

Значение свойства

string

apiVersionSet

apiVersionSet: ApiVersionSet

Значение свойства

apiWiki

apiWiki: ApiWiki

Значение свойства

apiWikis

apiWikis: ApiWikis

Значение свойства

authorization

authorization: Authorization

Значение свойства

authorizationAccessPolicy

authorizationAccessPolicy: AuthorizationAccessPolicy

Значение свойства

authorizationLoginLinks: AuthorizationLoginLinks

Значение свойства

authorizationProvider

authorizationProvider: AuthorizationProvider

Значение свойства

authorizationServer

authorizationServer: AuthorizationServer

Значение свойства

backend

backend: Backend

Значение свойства

cache

cache: Cache_2

Значение свойства

certificate

certificate: Certificate

Значение свойства

contentItem

contentItem: ContentItem

Значение свойства

contentType

contentType: ContentType

Значение свойства

delegationSettings

delegationSettings: DelegationSettings

Значение свойства

deletedServices

deletedServices: DeletedServices

Значение свойства

diagnostic

diagnostic: Diagnostic

Значение свойства

documentation

documentation: Documentation

Значение свойства

emailTemplate

emailTemplate: EmailTemplate

Значение свойства

gateway

gateway: Gateway

Значение свойства

gatewayApi

gatewayApi: GatewayApi

Значение свойства

gatewayCertificateAuthority

gatewayCertificateAuthority: GatewayCertificateAuthority

Значение свойства

gatewayHostnameConfiguration

gatewayHostnameConfiguration: GatewayHostnameConfiguration

Значение свойства

globalSchema

globalSchema: GlobalSchema

Значение свойства

graphQLApiResolver

graphQLApiResolver: GraphQLApiResolver

Значение свойства

graphQLApiResolverPolicy

graphQLApiResolverPolicy: GraphQLApiResolverPolicy

Значение свойства

group

group: Group

Значение свойства

groupUser

groupUser: GroupUser

Значение свойства

identityProvider

identityProvider: IdentityProvider

Значение свойства

issue

issue: Issue

Значение свойства

logger

logger: Logger

Значение свойства

namedValue

namedValue: NamedValue

Значение свойства

networkStatus

networkStatus: NetworkStatus

Значение свойства

notification

notification: Notification_2

Значение свойства

notificationRecipientEmail

notificationRecipientEmail: NotificationRecipientEmail

Значение свойства

notificationRecipientUser

notificationRecipientUser: NotificationRecipientUser

Значение свойства

openIdConnectProvider

openIdConnectProvider: OpenIdConnectProvider

Значение свойства

operationOperations

operationOperations: OperationOperations

Значение свойства

outboundNetworkDependenciesEndpoints

outboundNetworkDependenciesEndpoints: OutboundNetworkDependenciesEndpoints

Значение свойства

policy

policy: Policy

Значение свойства

policyDescription

policyDescription: PolicyDescription

Значение свойства

policyFragment

policyFragment: PolicyFragment

Значение свойства

portalConfig

portalConfig: PortalConfig

Значение свойства

portalRevision

portalRevision: PortalRevision

Значение свойства

portalSettings

portalSettings: PortalSettings

Значение свойства

privateEndpointConnectionOperations

privateEndpointConnectionOperations: PrivateEndpointConnectionOperations

Значение свойства

product

product: Product

Значение свойства

productApi

productApi: ProductApi

Значение свойства

productGroup

productGroup: ProductGroup

Значение свойства

productPolicy

productPolicy: ProductPolicy

Значение свойства

productSubscriptions

productSubscriptions: ProductSubscriptions

Значение свойства

productWiki

productWiki: ProductWiki

Значение свойства

productWikis

productWikis: ProductWikis

Значение свойства

quotaByCounterKeys

quotaByCounterKeys: QuotaByCounterKeys

Значение свойства

quotaByPeriodKeys

quotaByPeriodKeys: QuotaByPeriodKeys

Значение свойства

region

region: Region

Значение свойства

reports

reports: Reports

Значение свойства

signInSettings

signInSettings: SignInSettings

Значение свойства

signUpSettings

signUpSettings: SignUpSettings

Значение свойства

subscription

subscription: Subscription

Значение свойства

subscriptionId

subscriptionId?: string

Значение свойства

string

tag

tag: Tag

Значение свойства

Tag

tagResource

tagResource: TagResource

Значение свойства

tenantAccess

tenantAccess: TenantAccess

Значение свойства

tenantAccessGit

tenantAccessGit: TenantAccessGit

Значение свойства

tenantConfiguration

tenantConfiguration: TenantConfiguration

Значение свойства

tenantSettings

tenantSettings: TenantSettings

Значение свойства

user

user: User

Значение свойства

userConfirmationPassword

userConfirmationPassword: UserConfirmationPassword

Значение свойства

userGroup

userGroup: UserGroup

Значение свойства

userIdentities

userIdentities: UserIdentities

Значение свойства

userSubscription

userSubscription: UserSubscription

Значение свойства

Сведения об унаследованном свойстве

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

Параметры параметров.

Возвращаемое значение

Сведения о наследуемом методе

sendOperationRequest<T>(OperationArguments, OperationSpec)

Отправьте HTTP-запрос, который заполняется с помощью предоставленного OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Параметры

operationArguments
OperationArguments

Аргументы, из которым будут заполнены шаблонные значения HTTP-запроса.

operationSpec
OperationSpec

OperationSpec, используемый для заполнения httpRequest.

Возвращаемое значение

Promise<T>

Наследуется от coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Отправка предоставленного httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Параметры

request
PipelineRequest

Возвращаемое значение

Promise<PipelineResponse>

Наследуется от coreClient.ServiceClient.sendRequest