Compartir a través de


ApiManagementClient class

Extends

Constructores

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

Inicializa una nueva instancia de la clase ApiManagementClient.

Propiedades

$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

Propiedades heredadas

pipeline

La canalización usada por este cliente para realizar solicitudes

Métodos

beginPerformConnectivityCheckAsync(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Realiza una comprobación de conectividad entre el servicio API Management y un destino determinado, y devuelve métricas para la conexión, así como errores detectados al intentar establecerla.

beginPerformConnectivityCheckAsyncAndWait(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Realiza una comprobación de conectividad entre el servicio API Management y un destino determinado, y devuelve métricas para la conexión, así como errores detectados al intentar establecerla.

Métodos heredados

sendOperationRequest<T>(OperationArguments, OperationSpec)

Envíe una solicitud HTTP que se rellene mediante operationSpec proporcionada.

sendRequest(PipelineRequest)

Envíe el httpRequest proporcionado.

Detalles del constructor

ApiManagementClient(TokenCredential, ApiManagementClientOptionalParams)

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

Parámetros

credentials
TokenCredential

ApiManagementClient(TokenCredential, string, ApiManagementClientOptionalParams)

Inicializa una nueva instancia de la clase ApiManagementClient.

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

Parámetros

credentials
TokenCredential

Credenciales de suscripción que identifican de forma única la suscripción de cliente.

subscriptionId

string

Identificador de la suscripción de destino.

options
ApiManagementClientOptionalParams

Opciones del parámetro

Detalles de las propiedades

$host

$host: string

Valor de propiedad

string

api

api: Api

Valor de propiedad

Api

apiDiagnostic

apiDiagnostic: ApiDiagnostic

Valor de propiedad

apiExport

apiExport: ApiExport

Valor de propiedad

apiIssue

apiIssue: ApiIssue

Valor de propiedad

apiIssueAttachment

apiIssueAttachment: ApiIssueAttachment

Valor de propiedad

apiIssueComment

apiIssueComment: ApiIssueComment

Valor de propiedad

apiManagementOperations

apiManagementOperations: ApiManagementOperations

Valor de propiedad

apiManagementService

apiManagementService: ApiManagementService

Valor de propiedad

apiManagementServiceSkus

apiManagementServiceSkus: ApiManagementServiceSkus

Valor de propiedad

apiManagementSkus

apiManagementSkus: ApiManagementSkus

Valor de propiedad

apiOperation

apiOperation: ApiOperation

Valor de propiedad

apiOperationPolicy

apiOperationPolicy: ApiOperationPolicy

Valor de propiedad

apiPolicy

apiPolicy: ApiPolicy

Valor de propiedad

apiProduct

apiProduct: ApiProduct

Valor de propiedad

apiRelease

apiRelease: ApiRelease

Valor de propiedad

apiRevision

apiRevision: ApiRevision

Valor de propiedad

apiSchema

apiSchema: ApiSchema

Valor de propiedad

apiTagDescription

apiTagDescription: ApiTagDescription

Valor de propiedad

apiVersion

apiVersion: string

Valor de propiedad

string

apiVersionSet

apiVersionSet: ApiVersionSet

Valor de propiedad

apiWiki

apiWiki: ApiWiki

Valor de propiedad

apiWikis

apiWikis: ApiWikis

Valor de propiedad

authorization

authorization: Authorization

Valor de propiedad

authorizationAccessPolicy

authorizationAccessPolicy: AuthorizationAccessPolicy

Valor de propiedad

authorizationLoginLinks: AuthorizationLoginLinks

Valor de propiedad

authorizationProvider

authorizationProvider: AuthorizationProvider

Valor de propiedad

authorizationServer

authorizationServer: AuthorizationServer

Valor de propiedad

backend

backend: Backend

Valor de propiedad

cache

cache: Cache_2

Valor de propiedad

certificate

certificate: Certificate

Valor de propiedad

contentItem

contentItem: ContentItem

Valor de propiedad

contentType

contentType: ContentType

Valor de propiedad

delegationSettings

delegationSettings: DelegationSettings

Valor de propiedad

deletedServices

deletedServices: DeletedServices

Valor de propiedad

diagnostic

diagnostic: Diagnostic

Valor de propiedad

documentation

documentation: Documentation

Valor de propiedad

emailTemplate

emailTemplate: EmailTemplate

Valor de propiedad

gateway

gateway: Gateway

Valor de propiedad

gatewayApi

gatewayApi: GatewayApi

Valor de propiedad

gatewayCertificateAuthority

gatewayCertificateAuthority: GatewayCertificateAuthority

Valor de propiedad

gatewayHostnameConfiguration

gatewayHostnameConfiguration: GatewayHostnameConfiguration

Valor de propiedad

globalSchema

globalSchema: GlobalSchema

Valor de propiedad

graphQLApiResolver

graphQLApiResolver: GraphQLApiResolver

Valor de propiedad

graphQLApiResolverPolicy

graphQLApiResolverPolicy: GraphQLApiResolverPolicy

Valor de propiedad

group

group: Group

Valor de propiedad

groupUser

groupUser: GroupUser

Valor de propiedad

identityProvider

identityProvider: IdentityProvider

Valor de propiedad

issue

issue: Issue

Valor de propiedad

logger

logger: Logger

Valor de propiedad

namedValue

namedValue: NamedValue

Valor de propiedad

networkStatus

networkStatus: NetworkStatus

Valor de propiedad

notification

notification: Notification_2

Valor de propiedad

notificationRecipientEmail

notificationRecipientEmail: NotificationRecipientEmail

Valor de propiedad

notificationRecipientUser

notificationRecipientUser: NotificationRecipientUser

Valor de propiedad

openIdConnectProvider

openIdConnectProvider: OpenIdConnectProvider

Valor de propiedad

operationOperations

operationOperations: OperationOperations

Valor de propiedad

outboundNetworkDependenciesEndpoints

outboundNetworkDependenciesEndpoints: OutboundNetworkDependenciesEndpoints

Valor de propiedad

policy

policy: Policy

Valor de propiedad

policyDescription

policyDescription: PolicyDescription

Valor de propiedad

policyFragment

policyFragment: PolicyFragment

Valor de propiedad

portalConfig

portalConfig: PortalConfig

Valor de propiedad

portalRevision

portalRevision: PortalRevision

Valor de propiedad

portalSettings

portalSettings: PortalSettings

Valor de propiedad

privateEndpointConnectionOperations

privateEndpointConnectionOperations: PrivateEndpointConnectionOperations

Valor de propiedad

product

product: Product

Valor de propiedad

productApi

productApi: ProductApi

Valor de propiedad

productGroup

productGroup: ProductGroup

Valor de propiedad

productPolicy

productPolicy: ProductPolicy

Valor de propiedad

productSubscriptions

productSubscriptions: ProductSubscriptions

Valor de propiedad

productWiki

productWiki: ProductWiki

Valor de propiedad

productWikis

productWikis: ProductWikis

Valor de propiedad

quotaByCounterKeys

quotaByCounterKeys: QuotaByCounterKeys

Valor de propiedad

quotaByPeriodKeys

quotaByPeriodKeys: QuotaByPeriodKeys

Valor de propiedad

region

region: Region

Valor de propiedad

reports

reports: Reports

Valor de propiedad

signInSettings

signInSettings: SignInSettings

Valor de propiedad

signUpSettings

signUpSettings: SignUpSettings

Valor de propiedad

subscription

subscription: Subscription

Valor de propiedad

subscriptionId

subscriptionId?: string

Valor de propiedad

string

tag

tag: Tag

Valor de propiedad

Tag

tagResource

tagResource: TagResource

Valor de propiedad

tenantAccess

tenantAccess: TenantAccess

Valor de propiedad

tenantAccessGit

tenantAccessGit: TenantAccessGit

Valor de propiedad

tenantConfiguration

tenantConfiguration: TenantConfiguration

Valor de propiedad

tenantSettings

tenantSettings: TenantSettings

Valor de propiedad

user

user: User

Valor de propiedad

userConfirmationPassword

userConfirmationPassword: UserConfirmationPassword

Valor de propiedad

userGroup

userGroup: UserGroup

Valor de propiedad

userIdentities

userIdentities: UserIdentities

Valor de propiedad

userSubscription

userSubscription: UserSubscription

Valor de propiedad

Detalles de las propiedades heredadas

pipeline

La canalización usada por este cliente para realizar solicitudes

pipeline: Pipeline

Valor de propiedad

Heredado de coreClient.ServiceClient.pipeline

Detalles del método

beginPerformConnectivityCheckAsync(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Realiza una comprobación de conectividad entre el servicio API Management y un destino determinado, y devuelve métricas para la conexión, así como errores detectados al intentar establecerla.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

connectivityCheckRequestParams
ConnectivityCheckRequest

Parámetros de solicitud de comprobación de conectividad.

options
PerformConnectivityCheckAsyncOptionalParams

Parámetros de opciones.

Devoluciones

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

beginPerformConnectivityCheckAsyncAndWait(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Realiza una comprobación de conectividad entre el servicio API Management y un destino determinado, y devuelve métricas para la conexión, así como errores detectados al intentar establecerla.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

connectivityCheckRequestParams
ConnectivityCheckRequest

Parámetros de solicitud de comprobación de conectividad.

options
PerformConnectivityCheckAsyncOptionalParams

Parámetros de opciones.

Devoluciones

Detalles de los métodos heredados

sendOperationRequest<T>(OperationArguments, OperationSpec)

Envíe una solicitud HTTP que se rellene mediante operationSpec proporcionada.

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

Parámetros

operationArguments
OperationArguments

Argumentos de los que se rellenarán los valores con plantilla de la solicitud HTTP.

operationSpec
OperationSpec

OperationSpec que se va a usar para rellenar httpRequest.

Devoluciones

Promise<T>

Heredado de coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Envíe el httpRequest proporcionado.

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

Parámetros

request
PipelineRequest

Devoluciones

Promise<PipelineResponse>

Heredado de coreClient.ServiceClient.sendRequest