Partilhar 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 utilizado por este cliente para fazer pedidos

Métodos

beginPerformConnectivityCheckAsync(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Efetua uma verificação de conectividade entre o serviço Gestão de API e um determinado destino e devolve métricas para a ligação, bem como erros encontrados ao tentar estabelecer a ligação.

beginPerformConnectivityCheckAsyncAndWait(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Efetua uma verificação de conectividade entre o serviço Gestão de API e um determinado destino e devolve métricas para a ligação, bem como erros encontrados ao tentar estabelecer a ligação.

Métodos Herdados

sendOperationRequest<T>(OperationArguments, OperationSpec)

Envie um pedido HTTP que seja preenchido com 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 subscrição que identificam exclusivamente a subscrição do cliente.

subscriptionId

string

O ID da subscrição de destino.

options
ApiManagementClientOptionalParams

As opções de parâmetros

Detalhes de Propriedade

$host

$host: string

Valor de Propriedade

string

api

api: Api

Valor de Propriedade

Api

apiDiagnostic

apiDiagnostic: ApiDiagnostic

Valor de Propriedade

apiExport

apiExport: ApiExport

Valor de Propriedade

apiIssue

apiIssue: ApiIssue

Valor de Propriedade

apiIssueAttachment

apiIssueAttachment: ApiIssueAttachment

Valor de Propriedade

apiIssueComment

apiIssueComment: ApiIssueComment

Valor de Propriedade

apiManagementOperations

apiManagementOperations: ApiManagementOperations

Valor de Propriedade

apiManagementService

apiManagementService: ApiManagementService

Valor de Propriedade

apiManagementServiceSkus

apiManagementServiceSkus: ApiManagementServiceSkus

Valor de Propriedade

apiManagementSkus

apiManagementSkus: ApiManagementSkus

Valor de Propriedade

apiOperation

apiOperation: ApiOperation

Valor de Propriedade

apiOperationPolicy

apiOperationPolicy: ApiOperationPolicy

Valor de Propriedade

apiPolicy

apiPolicy: ApiPolicy

Valor de Propriedade

apiProduct

apiProduct: ApiProduct

Valor de Propriedade

apiRelease

apiRelease: ApiRelease

Valor de Propriedade

apiRevision

apiRevision: ApiRevision

Valor de Propriedade

apiSchema

apiSchema: ApiSchema

Valor de Propriedade

apiTagDescription

apiTagDescription: ApiTagDescription

Valor de Propriedade

apiVersion

apiVersion: string

Valor de Propriedade

string

apiVersionSet

apiVersionSet: ApiVersionSet

Valor de Propriedade

apiWiki

apiWiki: ApiWiki

Valor de Propriedade

apiWikis

apiWikis: ApiWikis

Valor de Propriedade

authorization

authorization: Authorization

Valor de Propriedade

authorizationAccessPolicy

authorizationAccessPolicy: AuthorizationAccessPolicy

Valor de Propriedade

authorizationLoginLinks: AuthorizationLoginLinks

Valor de Propriedade

authorizationProvider

authorizationProvider: AuthorizationProvider

Valor de Propriedade

authorizationServer

authorizationServer: AuthorizationServer

Valor de Propriedade

backend

backend: Backend

Valor de Propriedade

cache

cache: Cache_2

Valor de Propriedade

certificate

certificate: Certificate

Valor de Propriedade

contentItem

contentItem: ContentItem

Valor de Propriedade

contentType

contentType: ContentType

Valor de Propriedade

delegationSettings

delegationSettings: DelegationSettings

Valor de Propriedade

deletedServices

deletedServices: DeletedServices

Valor de Propriedade

diagnostic

diagnostic: Diagnostic

Valor de Propriedade

documentation

documentation: Documentation

Valor de Propriedade

emailTemplate

emailTemplate: EmailTemplate

Valor de Propriedade

gateway

gateway: Gateway

Valor de Propriedade

gatewayApi

gatewayApi: GatewayApi

Valor de Propriedade

gatewayCertificateAuthority

gatewayCertificateAuthority: GatewayCertificateAuthority

Valor de Propriedade

gatewayHostnameConfiguration

gatewayHostnameConfiguration: GatewayHostnameConfiguration

Valor de Propriedade

globalSchema

globalSchema: GlobalSchema

Valor de Propriedade

graphQLApiResolver

graphQLApiResolver: GraphQLApiResolver

Valor de Propriedade

graphQLApiResolverPolicy

graphQLApiResolverPolicy: GraphQLApiResolverPolicy

Valor de Propriedade

group

group: Group

Valor de Propriedade

groupUser

groupUser: GroupUser

Valor de Propriedade

identityProvider

identityProvider: IdentityProvider

Valor de Propriedade

issue

issue: Issue

Valor de Propriedade

logger

logger: Logger

Valor de Propriedade

namedValue

namedValue: NamedValue

Valor de Propriedade

networkStatus

networkStatus: NetworkStatus

Valor de Propriedade

notification

notification: Notification_2

Valor de Propriedade

notificationRecipientEmail

notificationRecipientEmail: NotificationRecipientEmail

Valor de Propriedade

notificationRecipientUser

notificationRecipientUser: NotificationRecipientUser

Valor de Propriedade

openIdConnectProvider

openIdConnectProvider: OpenIdConnectProvider

Valor de Propriedade

operationOperations

operationOperations: OperationOperations

Valor de Propriedade

outboundNetworkDependenciesEndpoints

outboundNetworkDependenciesEndpoints: OutboundNetworkDependenciesEndpoints

Valor de Propriedade

policy

policy: Policy

Valor de Propriedade

policyDescription

policyDescription: PolicyDescription

Valor de Propriedade

policyFragment

policyFragment: PolicyFragment

Valor de Propriedade

portalConfig

portalConfig: PortalConfig

Valor de Propriedade

portalRevision

portalRevision: PortalRevision

Valor de Propriedade

portalSettings

portalSettings: PortalSettings

Valor de Propriedade

privateEndpointConnectionOperations

privateEndpointConnectionOperations: PrivateEndpointConnectionOperations

Valor de Propriedade

product

product: Product

Valor de Propriedade

productApi

productApi: ProductApi

Valor de Propriedade

productGroup

productGroup: ProductGroup

Valor de Propriedade

productPolicy

productPolicy: ProductPolicy

Valor de Propriedade

productSubscriptions

productSubscriptions: ProductSubscriptions

Valor de Propriedade

productWiki

productWiki: ProductWiki

Valor de Propriedade

productWikis

productWikis: ProductWikis

Valor de Propriedade

quotaByCounterKeys

quotaByCounterKeys: QuotaByCounterKeys

Valor de Propriedade

quotaByPeriodKeys

quotaByPeriodKeys: QuotaByPeriodKeys

Valor de Propriedade

region

region: Region

Valor de Propriedade

reports

reports: Reports

Valor de Propriedade

signInSettings

signInSettings: SignInSettings

Valor de Propriedade

signUpSettings

signUpSettings: SignUpSettings

Valor de Propriedade

subscription

subscription: Subscription

Valor de Propriedade

subscriptionId

subscriptionId?: string

Valor de Propriedade

string

tag

tag: Tag

Valor de Propriedade

Tag

tagResource

tagResource: TagResource

Valor de Propriedade

tenantAccess

tenantAccess: TenantAccess

Valor de Propriedade

tenantAccessGit

tenantAccessGit: TenantAccessGit

Valor de Propriedade

tenantConfiguration

tenantConfiguration: TenantConfiguration

Valor de Propriedade

tenantSettings

tenantSettings: TenantSettings

Valor de Propriedade

user

user: User

Valor de Propriedade

userConfirmationPassword

userConfirmationPassword: UserConfirmationPassword

Valor de Propriedade

userGroup

userGroup: UserGroup

Valor de Propriedade

userIdentities

userIdentities: UserIdentities

Valor de Propriedade

userSubscription

userSubscription: UserSubscription

Valor de Propriedade

Detalhes da Propriedade Herdada

pipeline

O pipeline utilizado por este cliente para fazer pedidos

pipeline: Pipeline

Valor de Propriedade

Herdado de coreClient.ServiceClient.pipeline

Detalhes de Método

beginPerformConnectivityCheckAsync(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Efetua uma verificação de conectividade entre o serviço Gestão de API e um determinado destino e devolve métricas para a ligação, bem como erros encontrados ao tentar estabelecer a ligaçã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 não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

connectivityCheckRequestParams
ConnectivityCheckRequest

Conectividade Verificar parâmetros de pedido.

options
PerformConnectivityCheckAsyncOptionalParams

Os parâmetros de opções.

Devoluções

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

beginPerformConnectivityCheckAsyncAndWait(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Efetua uma verificação de conectividade entre o serviço Gestão de API e um determinado destino e devolve métricas para a ligação, bem como erros encontrados ao tentar estabelecer a ligaçã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 não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

connectivityCheckRequestParams
ConnectivityCheckRequest

Conectividade Verificar parâmetros de pedido.

options
PerformConnectivityCheckAsyncOptionalParams

Os parâmetros de opções.

Devoluções

Detalhes do Método Herdado

sendOperationRequest<T>(OperationArguments, OperationSpec)

Envie um pedido HTTP que seja preenchido com o OperationSpec fornecido.

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

Parâmetros

operationArguments
OperationArguments

Os argumentos a partir dos quais os valores de modelo do pedido HTTP serão preenchidos.

operationSpec
OperationSpec

O OperationSpec a utilizar para preencher o httpRequest.

Devoluções

Promise<T>

Herdado de coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Envie o httpRequest fornecido.

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

Parâmetros

request
PipelineRequest

Devoluções

Promise<PipelineResponse>

Herdado de coreClient.ServiceClient.sendRequest