ApiManagementClient class
- Extends
Konstruktoren
Api |
|
Api |
Initialisiert eine neue instance der ApiManagementClient-Klasse. |
Eigenschaften
Geerbte Eigenschaften
pipeline | Die Pipeline, die von diesem Client zum Senden von Anforderungen verwendet wird |
Methoden
begin |
Führt eine Konnektivitätsprüfung zwischen dem API Management Dienst und einem bestimmten Ziel durch und gibt Metriken für die Verbindung sowie Fehler zurück, die beim Einrichten der Verbindung aufgetreten sind. |
begin |
Führt eine Konnektivitätsprüfung zwischen dem API Management Dienst und einem bestimmten Ziel durch und gibt Metriken für die Verbindung sowie Fehler zurück, die beim Einrichten der Verbindung aufgetreten sind. |
Geerbte Methoden
send |
Senden Sie eine HTTP-Anforderung, die mithilfe der angegebenen OperationSpec aufgefüllt wird. |
send |
Senden Sie die bereitgestellte httpRequest. |
Details zum Konstruktor
ApiManagementClient(TokenCredential, ApiManagementClientOptionalParams)
new ApiManagementClient(credentials: TokenCredential, options?: ApiManagementClientOptionalParams)
Parameter
- credentials
- TokenCredential
ApiManagementClient(TokenCredential, string, ApiManagementClientOptionalParams)
Initialisiert eine neue instance der ApiManagementClient-Klasse.
new ApiManagementClient(credentials: TokenCredential, subscriptionId: string, options?: ApiManagementClientOptionalParams)
Parameter
- credentials
- TokenCredential
Abonnementanmeldeinformationen, die das Clientabonnement eindeutig identifizieren.
- subscriptionId
-
string
Hierbei handelt es sich um die ID des Zielabonnements.
Parameteroptionen
Details zur Eigenschaft
$host
$host: string
Eigenschaftswert
string
api
apiDiagnostic
apiExport
apiIssue
apiIssueAttachment
apiIssueComment
apiManagementOperations
apiManagementService
apiManagementServiceSkus
apiManagementSkus
apiOperation
apiOperationPolicy
apiPolicy
apiProduct
apiRelease
apiRevision
apiSchema
apiTagDescription
apiVersion
apiVersion: string
Eigenschaftswert
string
apiVersionSet
apiWiki
apiWikis
authorization
authorizationAccessPolicy
authorizationLoginLinks
authorizationProvider
authorizationServer
backend
cache
certificate
contentItem
contentType
delegationSettings
deletedServices
diagnostic
documentation
emailTemplate
gateway
gatewayApi
gatewayCertificateAuthority
gatewayCertificateAuthority: GatewayCertificateAuthority
Eigenschaftswert
gatewayHostnameConfiguration
gatewayHostnameConfiguration: GatewayHostnameConfiguration
Eigenschaftswert
globalSchema
graphQLApiResolver
graphQLApiResolverPolicy
group
groupUser
identityProvider
issue
logger
namedValue
networkStatus
notification
notificationRecipientEmail
notificationRecipientUser
openIdConnectProvider
operationOperations
outboundNetworkDependenciesEndpoints
outboundNetworkDependenciesEndpoints: OutboundNetworkDependenciesEndpoints
Eigenschaftswert
policy
policyDescription
policyFragment
portalConfig
portalRevision
portalSettings
privateEndpointConnectionOperations
privateEndpointConnectionOperations: PrivateEndpointConnectionOperations
Eigenschaftswert
product
productApi
productGroup
productPolicy
productSubscriptions
productWiki
productWikis
quotaByCounterKeys
quotaByPeriodKeys
region
reports
signInSettings
signUpSettings
subscription
subscriptionId
subscriptionId?: string
Eigenschaftswert
string
tag
tagResource
tenantAccess
tenantAccessGit
tenantConfiguration
tenantSettings
user
userConfirmationPassword
userGroup
userIdentities
userSubscription
Geerbte Eigenschaftsdetails
pipeline
Die Pipeline, die von diesem Client zum Senden von Anforderungen verwendet wird
pipeline: Pipeline
Eigenschaftswert
Geerbt von coreClient.ServiceClient.pipeline
Details zur Methode
beginPerformConnectivityCheckAsync(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)
Führt eine Konnektivitätsprüfung zwischen dem API Management Dienst und einem bestimmten Ziel durch und gibt Metriken für die Verbindung sowie Fehler zurück, die beim Einrichten der Verbindung aufgetreten sind.
function beginPerformConnectivityCheckAsync(resourceGroupName: string, serviceName: string, connectivityCheckRequestParams: ConnectivityCheckRequest, options?: PerformConnectivityCheckAsyncOptionalParams): Promise<SimplePollerLike<OperationState<ConnectivityCheckResponse>, ConnectivityCheckResponse>>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- connectivityCheckRequestParams
- ConnectivityCheckRequest
Verbindungsüberprüfungsanforderungsparameter.
Die Optionsparameter.
Gibt zurück
Promise<@azure/core-lro.SimplePollerLike<OperationState<ConnectivityCheckResponse>, ConnectivityCheckResponse>>
beginPerformConnectivityCheckAsyncAndWait(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)
Führt eine Konnektivitätsprüfung zwischen dem API Management Dienst und einem bestimmten Ziel durch und gibt Metriken für die Verbindung sowie Fehler zurück, die beim Einrichten der Verbindung aufgetreten sind.
function beginPerformConnectivityCheckAsyncAndWait(resourceGroupName: string, serviceName: string, connectivityCheckRequestParams: ConnectivityCheckRequest, options?: PerformConnectivityCheckAsyncOptionalParams): Promise<ConnectivityCheckResponse>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- connectivityCheckRequestParams
- ConnectivityCheckRequest
Verbindungsüberprüfungsanforderungsparameter.
Die Optionsparameter.
Gibt zurück
Promise<ConnectivityCheckResponse>
Details zur geerbten Methode
sendOperationRequest<T>(OperationArguments, OperationSpec)
Senden Sie eine HTTP-Anforderung, die mithilfe der angegebenen OperationSpec aufgefüllt wird.
function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>
Parameter
- operationArguments
- OperationArguments
Die Argumente, von denen die vorlagenbasierten Werte der HTTP-Anforderung aufgefüllt werden.
- operationSpec
- OperationSpec
Die OperationSpec, die zum Auffüllen von httpRequest verwendet werden soll.
Gibt zurück
Promise<T>
Geerbt von coreClient.ServiceClient.sendOperationRequest
sendRequest(PipelineRequest)
Senden Sie die bereitgestellte httpRequest.
function sendRequest(request: PipelineRequest): Promise<PipelineResponse>
Parameter
- request
- PipelineRequest
Gibt zurück
Promise<PipelineResponse>
Geerbt von coreClient.ServiceClient.sendRequest