Compartilhar via


ApiManagementClient class

Extends

Construtores

ApiManagementClient(TokenCredential, ApiManagementClientOptionalParams)
ApiManagementClient(TokenCredential, string, ApiManagementClientOptionalParams)

Inicializa uma nova instância da classe ApiManagementClient.

Propriedades

$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

Propriedades herdadas

pipeline

O pipeline usado por esse cliente para fazer solicitações

Métodos

beginPerformConnectivityCheckAsync(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Executa uma marcar de conectividade entre o serviço de Gerenciamento de API e um determinado destino e retorna métricas para a conexão, bem como erros encontrados ao tentar estabeleça-o.

beginPerformConnectivityCheckAsyncAndWait(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Executa uma marcar de conectividade entre o serviço de Gerenciamento de API e um determinado destino e retorna métricas para a conexão, bem como erros encontrados ao tentar estabeleça-o.

Métodos herdados

sendOperationRequest<T>(OperationArguments, OperationSpec)

Envie uma solicitação HTTP preenchida usando o OperationSpec fornecido.

sendRequest(PipelineRequest)

Envie o httpRequest fornecido.

Detalhes do construtor

ApiManagementClient(TokenCredential, ApiManagementClientOptionalParams)

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

Parâmetros

credentials
TokenCredential

ApiManagementClient(TokenCredential, string, ApiManagementClientOptionalParams)

Inicializa uma nova instância da classe ApiManagementClient.

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

Parâmetros

credentials
TokenCredential

Credenciais de assinatura que identificam exclusivamente a assinatura do cliente.

subscriptionId

string

A ID da assinatura de destino.

options
ApiManagementClientOptionalParams

As opções de parâmetro

Detalhes da propriedade

$host

$host: string

Valor da propriedade

string

api

api: Api

Valor da propriedade

Api

apiDiagnostic

apiDiagnostic: ApiDiagnostic

Valor da propriedade

apiExport

apiExport: ApiExport

Valor da propriedade

apiIssue

apiIssue: ApiIssue

Valor da propriedade

apiIssueAttachment

apiIssueAttachment: ApiIssueAttachment

Valor da propriedade

apiIssueComment

apiIssueComment: ApiIssueComment

Valor da propriedade

apiManagementOperations

apiManagementOperations: ApiManagementOperations

Valor da propriedade

apiManagementService

apiManagementService: ApiManagementService

Valor da propriedade

apiManagementServiceSkus

apiManagementServiceSkus: ApiManagementServiceSkus

Valor da propriedade

apiManagementSkus

apiManagementSkus: ApiManagementSkus

Valor da propriedade

apiOperation

apiOperation: ApiOperation

Valor da propriedade

apiOperationPolicy

apiOperationPolicy: ApiOperationPolicy

Valor da propriedade

apiPolicy

apiPolicy: ApiPolicy

Valor da propriedade

apiProduct

apiProduct: ApiProduct

Valor da propriedade

apiRelease

apiRelease: ApiRelease

Valor da propriedade

apiRevision

apiRevision: ApiRevision

Valor da propriedade

apiSchema

apiSchema: ApiSchema

Valor da propriedade

apiTagDescription

apiTagDescription: ApiTagDescription

Valor da propriedade

apiVersion

apiVersion: string

Valor da propriedade

string

apiVersionSet

apiVersionSet: ApiVersionSet

Valor da propriedade

apiWiki

apiWiki: ApiWiki

Valor da propriedade

apiWikis

apiWikis: ApiWikis

Valor da propriedade

authorization

authorization: Authorization

Valor da propriedade

authorizationAccessPolicy

authorizationAccessPolicy: AuthorizationAccessPolicy

Valor da propriedade

authorizationLoginLinks: AuthorizationLoginLinks

Valor da propriedade

authorizationProvider

authorizationProvider: AuthorizationProvider

Valor da propriedade

authorizationServer

authorizationServer: AuthorizationServer

Valor da propriedade

backend

backend: Backend

Valor da propriedade

cache

cache: Cache_2

Valor da propriedade

certificate

certificate: Certificate

Valor da propriedade

contentItem

contentItem: ContentItem

Valor da propriedade

contentType

contentType: ContentType

Valor da propriedade

delegationSettings

delegationSettings: DelegationSettings

Valor da propriedade

deletedServices

deletedServices: DeletedServices

Valor da propriedade

diagnostic

diagnostic: Diagnostic

Valor da propriedade

documentation

documentation: Documentation

Valor da propriedade

emailTemplate

emailTemplate: EmailTemplate

Valor da propriedade

gateway

gateway: Gateway

Valor da propriedade

gatewayApi

gatewayApi: GatewayApi

Valor da propriedade

gatewayCertificateAuthority

gatewayCertificateAuthority: GatewayCertificateAuthority

Valor da propriedade

gatewayHostnameConfiguration

gatewayHostnameConfiguration: GatewayHostnameConfiguration

Valor da propriedade

globalSchema

globalSchema: GlobalSchema

Valor da propriedade

graphQLApiResolver

graphQLApiResolver: GraphQLApiResolver

Valor da propriedade

graphQLApiResolverPolicy

graphQLApiResolverPolicy: GraphQLApiResolverPolicy

Valor da propriedade

group

group: Group

Valor da propriedade

groupUser

groupUser: GroupUser

Valor da propriedade

identityProvider

identityProvider: IdentityProvider

Valor da propriedade

issue

issue: Issue

Valor da propriedade

logger

logger: Logger

Valor da propriedade

namedValue

namedValue: NamedValue

Valor da propriedade

networkStatus

networkStatus: NetworkStatus

Valor da propriedade

notification

notification: Notification_2

Valor da propriedade

notificationRecipientEmail

notificationRecipientEmail: NotificationRecipientEmail

Valor da propriedade

notificationRecipientUser

notificationRecipientUser: NotificationRecipientUser

Valor da propriedade

openIdConnectProvider

openIdConnectProvider: OpenIdConnectProvider

Valor da propriedade

operationOperations

operationOperations: OperationOperations

Valor da propriedade

outboundNetworkDependenciesEndpoints

outboundNetworkDependenciesEndpoints: OutboundNetworkDependenciesEndpoints

Valor da propriedade

policy

policy: Policy

Valor da propriedade

policyDescription

policyDescription: PolicyDescription

Valor da propriedade

policyFragment

policyFragment: PolicyFragment

Valor da propriedade

portalConfig

portalConfig: PortalConfig

Valor da propriedade

portalRevision

portalRevision: PortalRevision

Valor da propriedade

portalSettings

portalSettings: PortalSettings

Valor da propriedade

privateEndpointConnectionOperations

privateEndpointConnectionOperations: PrivateEndpointConnectionOperations

Valor da propriedade

product

product: Product

Valor da propriedade

productApi

productApi: ProductApi

Valor da propriedade

productGroup

productGroup: ProductGroup

Valor da propriedade

productPolicy

productPolicy: ProductPolicy

Valor da propriedade

productSubscriptions

productSubscriptions: ProductSubscriptions

Valor da propriedade

productWiki

productWiki: ProductWiki

Valor da propriedade

productWikis

productWikis: ProductWikis

Valor da propriedade

quotaByCounterKeys

quotaByCounterKeys: QuotaByCounterKeys

Valor da propriedade

quotaByPeriodKeys

quotaByPeriodKeys: QuotaByPeriodKeys

Valor da propriedade

region

region: Region

Valor da propriedade

reports

reports: Reports

Valor da propriedade

signInSettings

signInSettings: SignInSettings

Valor da propriedade

signUpSettings

signUpSettings: SignUpSettings

Valor da propriedade

subscription

subscription: Subscription

Valor da propriedade

subscriptionId

subscriptionId?: string

Valor da propriedade

string

tag

tag: Tag

Valor da propriedade

Tag

tagResource

tagResource: TagResource

Valor da propriedade

tenantAccess

tenantAccess: TenantAccess

Valor da propriedade

tenantAccessGit

tenantAccessGit: TenantAccessGit

Valor da propriedade

tenantConfiguration

tenantConfiguration: TenantConfiguration

Valor da propriedade

tenantSettings

tenantSettings: TenantSettings

Valor da propriedade

user

user: User

Valor da propriedade

userConfirmationPassword

userConfirmationPassword: UserConfirmationPassword

Valor da propriedade

userGroup

userGroup: UserGroup

Valor da propriedade

userIdentities

userIdentities: UserIdentities

Valor da propriedade

userSubscription

userSubscription: UserSubscription

Valor da propriedade

Detalhes das propriedades herdadas

pipeline

O pipeline usado por esse cliente para fazer solicitações

pipeline: Pipeline

Valor da propriedade

Herdado de coreClient.ServiceClient.pipeline

Detalhes do método

beginPerformConnectivityCheckAsync(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Executa uma marcar de conectividade entre o serviço de Gerenciamento de API e um determinado destino e retorna métricas para a conexão, bem como erros encontrados ao tentar estabeleça-o.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

connectivityCheckRequestParams
ConnectivityCheckRequest

Parâmetros de solicitação de verificação de conectividade.

options
PerformConnectivityCheckAsyncOptionalParams

Os parâmetros de opções.

Retornos

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

beginPerformConnectivityCheckAsyncAndWait(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Executa uma marcar de conectividade entre o serviço de Gerenciamento de API e um determinado destino e retorna métricas para a conexão, bem como erros encontrados ao tentar estabeleça-o.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

connectivityCheckRequestParams
ConnectivityCheckRequest

Parâmetros de solicitação de verificação de conectividade.

options
PerformConnectivityCheckAsyncOptionalParams

Os parâmetros de opções.

Retornos

Detalhes do método herdado

sendOperationRequest<T>(OperationArguments, OperationSpec)

Envie uma solicitação HTTP preenchida usando o OperationSpec fornecido.

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

Parâmetros

operationArguments
OperationArguments

Os argumentos dos quais os valores de modelo da solicitação HTTP serão preenchidos.

operationSpec
OperationSpec

O OperationSpec a ser usado para preencher o httpRequest.

Retornos

Promise<T>

Herdado de coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Envie o httpRequest fornecido.

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

Parâmetros

request
PipelineRequest

Retornos

Promise<PipelineResponse>

Herdado de coreClient.ServiceClient.sendRequest