Freigeben über


ApiManagementClient class

Extends

Konstruktoren

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

Initialisiert eine neue instance der ApiManagementClient-Klasse.

Eigenschaften

$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

Geerbte Eigenschaften

pipeline

Die Pipeline, die von diesem Client zum Senden von Anforderungen verwendet wird

Methoden

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.

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.

Geerbte Methoden

sendOperationRequest<T>(OperationArguments, OperationSpec)

Senden Sie eine HTTP-Anforderung, die mithilfe der angegebenen OperationSpec aufgefüllt wird.

sendRequest(PipelineRequest)

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.

options
ApiManagementClientOptionalParams

Parameteroptionen

Details zur Eigenschaft

$host

$host: string

Eigenschaftswert

string

api

api: Api

Eigenschaftswert

Api

apiDiagnostic

apiDiagnostic: ApiDiagnostic

Eigenschaftswert

apiExport

apiExport: ApiExport

Eigenschaftswert

apiIssue

apiIssue: ApiIssue

Eigenschaftswert

apiIssueAttachment

apiIssueAttachment: ApiIssueAttachment

Eigenschaftswert

apiIssueComment

apiIssueComment: ApiIssueComment

Eigenschaftswert

apiManagementOperations

apiManagementOperations: ApiManagementOperations

Eigenschaftswert

apiManagementService

apiManagementService: ApiManagementService

Eigenschaftswert

apiManagementServiceSkus

apiManagementServiceSkus: ApiManagementServiceSkus

Eigenschaftswert

apiManagementSkus

apiManagementSkus: ApiManagementSkus

Eigenschaftswert

apiOperation

apiOperation: ApiOperation

Eigenschaftswert

apiOperationPolicy

apiOperationPolicy: ApiOperationPolicy

Eigenschaftswert

apiPolicy

apiPolicy: ApiPolicy

Eigenschaftswert

apiProduct

apiProduct: ApiProduct

Eigenschaftswert

apiRelease

apiRelease: ApiRelease

Eigenschaftswert

apiRevision

apiRevision: ApiRevision

Eigenschaftswert

apiSchema

apiSchema: ApiSchema

Eigenschaftswert

apiTagDescription

apiTagDescription: ApiTagDescription

Eigenschaftswert

apiVersion

apiVersion: string

Eigenschaftswert

string

apiVersionSet

apiVersionSet: ApiVersionSet

Eigenschaftswert

apiWiki

apiWiki: ApiWiki

Eigenschaftswert

apiWikis

apiWikis: ApiWikis

Eigenschaftswert

authorization

authorization: Authorization

Eigenschaftswert

authorizationAccessPolicy

authorizationAccessPolicy: AuthorizationAccessPolicy

Eigenschaftswert

authorizationLoginLinks: AuthorizationLoginLinks

Eigenschaftswert

authorizationProvider

authorizationProvider: AuthorizationProvider

Eigenschaftswert

authorizationServer

authorizationServer: AuthorizationServer

Eigenschaftswert

backend

backend: Backend

Eigenschaftswert

cache

cache: Cache_2

Eigenschaftswert

certificate

certificate: Certificate

Eigenschaftswert

contentItem

contentItem: ContentItem

Eigenschaftswert

contentType

contentType: ContentType

Eigenschaftswert

delegationSettings

delegationSettings: DelegationSettings

Eigenschaftswert

deletedServices

deletedServices: DeletedServices

Eigenschaftswert

diagnostic

diagnostic: Diagnostic

Eigenschaftswert

documentation

documentation: Documentation

Eigenschaftswert

emailTemplate

emailTemplate: EmailTemplate

Eigenschaftswert

gateway

gateway: Gateway

Eigenschaftswert

gatewayApi

gatewayApi: GatewayApi

Eigenschaftswert

gatewayCertificateAuthority

gatewayCertificateAuthority: GatewayCertificateAuthority

Eigenschaftswert

gatewayHostnameConfiguration

gatewayHostnameConfiguration: GatewayHostnameConfiguration

Eigenschaftswert

globalSchema

globalSchema: GlobalSchema

Eigenschaftswert

graphQLApiResolver

graphQLApiResolver: GraphQLApiResolver

Eigenschaftswert

graphQLApiResolverPolicy

graphQLApiResolverPolicy: GraphQLApiResolverPolicy

Eigenschaftswert

group

group: Group

Eigenschaftswert

groupUser

groupUser: GroupUser

Eigenschaftswert

identityProvider

identityProvider: IdentityProvider

Eigenschaftswert

issue

issue: Issue

Eigenschaftswert

logger

logger: Logger

Eigenschaftswert

namedValue

namedValue: NamedValue

Eigenschaftswert

networkStatus

networkStatus: NetworkStatus

Eigenschaftswert

notification

notification: Notification_2

Eigenschaftswert

notificationRecipientEmail

notificationRecipientEmail: NotificationRecipientEmail

Eigenschaftswert

notificationRecipientUser

notificationRecipientUser: NotificationRecipientUser

Eigenschaftswert

openIdConnectProvider

openIdConnectProvider: OpenIdConnectProvider

Eigenschaftswert

operationOperations

operationOperations: OperationOperations

Eigenschaftswert

outboundNetworkDependenciesEndpoints

outboundNetworkDependenciesEndpoints: OutboundNetworkDependenciesEndpoints

Eigenschaftswert

policy

policy: Policy

Eigenschaftswert

policyDescription

policyDescription: PolicyDescription

Eigenschaftswert

policyFragment

policyFragment: PolicyFragment

Eigenschaftswert

portalConfig

portalConfig: PortalConfig

Eigenschaftswert

portalRevision

portalRevision: PortalRevision

Eigenschaftswert

portalSettings

portalSettings: PortalSettings

Eigenschaftswert

privateEndpointConnectionOperations

privateEndpointConnectionOperations: PrivateEndpointConnectionOperations

Eigenschaftswert

product

product: Product

Eigenschaftswert

productApi

productApi: ProductApi

Eigenschaftswert

productGroup

productGroup: ProductGroup

Eigenschaftswert

productPolicy

productPolicy: ProductPolicy

Eigenschaftswert

productSubscriptions

productSubscriptions: ProductSubscriptions

Eigenschaftswert

productWiki

productWiki: ProductWiki

Eigenschaftswert

productWikis

productWikis: ProductWikis

Eigenschaftswert

quotaByCounterKeys

quotaByCounterKeys: QuotaByCounterKeys

Eigenschaftswert

quotaByPeriodKeys

quotaByPeriodKeys: QuotaByPeriodKeys

Eigenschaftswert

region

region: Region

Eigenschaftswert

reports

reports: Reports

Eigenschaftswert

signInSettings

signInSettings: SignInSettings

Eigenschaftswert

signUpSettings

signUpSettings: SignUpSettings

Eigenschaftswert

subscription

subscription: Subscription

Eigenschaftswert

subscriptionId

subscriptionId?: string

Eigenschaftswert

string

tag

tag: Tag

Eigenschaftswert

Tag

tagResource

tagResource: TagResource

Eigenschaftswert

tenantAccess

tenantAccess: TenantAccess

Eigenschaftswert

tenantAccessGit

tenantAccessGit: TenantAccessGit

Eigenschaftswert

tenantConfiguration

tenantConfiguration: TenantConfiguration

Eigenschaftswert

tenantSettings

tenantSettings: TenantSettings

Eigenschaftswert

user

user: User

Eigenschaftswert

userConfirmationPassword

userConfirmationPassword: UserConfirmationPassword

Eigenschaftswert

userGroup

userGroup: UserGroup

Eigenschaftswert

userIdentities

userIdentities: UserIdentities

Eigenschaftswert

userSubscription

userSubscription: UserSubscription

Eigenschaftswert

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.

options
PerformConnectivityCheckAsyncOptionalParams

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.

options
PerformConnectivityCheckAsyncOptionalParams

Die Optionsparameter.

Gibt zurück

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