ApiManagementClient class
- Extends
Constructores
Api |
|
Api |
Inicializa una nueva instancia de la clase ApiManagementClient. |
Propiedades
Propiedades heredadas
pipeline | La canalización usada por este cliente para realizar solicitudes |
Métodos
begin |
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. |
begin |
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
send |
Envíe una solicitud HTTP que se rellene mediante operationSpec proporcionada. |
send |
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.
Opciones del parámetro
Detalles de las propiedades
$host
$host: string
Valor de propiedad
string
api
apiDiagnostic
apiExport
apiIssue
apiIssueAttachment
apiIssueComment
apiManagementOperations
apiManagementService
apiManagementServiceSkus
apiManagementSkus
apiOperation
apiOperationPolicy
apiPolicy
apiProduct
apiRelease
apiRevision
apiSchema
apiTagDescription
apiVersion
apiVersion: string
Valor de propiedad
string
apiVersionSet
apiWiki
apiWikis
authorization
authorizationAccessPolicy
authorizationLoginLinks
authorizationProvider
authorizationServer
backend
cache
certificate
contentItem
contentType
delegationSettings
deletedServices
diagnostic
documentation
emailTemplate
gateway
gatewayApi
gatewayCertificateAuthority
gatewayCertificateAuthority: GatewayCertificateAuthority
Valor de propiedad
gatewayHostnameConfiguration
gatewayHostnameConfiguration: GatewayHostnameConfiguration
Valor de propiedad
globalSchema
graphQLApiResolver
graphQLApiResolverPolicy
group
groupUser
identityProvider
issue
logger
namedValue
networkStatus
notification
notificationRecipientEmail
notificationRecipientEmail: NotificationRecipientEmail
Valor de propiedad
notificationRecipientUser
openIdConnectProvider
operationOperations
outboundNetworkDependenciesEndpoints
outboundNetworkDependenciesEndpoints: OutboundNetworkDependenciesEndpoints
Valor de propiedad
policy
policyDescription
policyFragment
portalConfig
portalRevision
portalSettings
privateEndpointConnectionOperations
privateEndpointConnectionOperations: PrivateEndpointConnectionOperations
Valor de propiedad
product
productApi
productGroup
productPolicy
productSubscriptions
productWiki
productWikis
quotaByCounterKeys
quotaByPeriodKeys
region
reports
signInSettings
signUpSettings
subscription
subscriptionId
subscriptionId?: string
Valor de propiedad
string
tag
tagResource
tenantAccess
tenantAccessGit
tenantConfiguration
tenantSettings
user
userConfirmationPassword
userGroup
userIdentities
userSubscription
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.
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.
Parámetros de opciones.
Devoluciones
Promise<ConnectivityCheckResponse>
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