Udostępnij za pośrednictwem


ApiManagementClient class

Rozszerzenie

Konstruktory

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

Inicjuje nowe wystąpienie klasy ApiManagementClient.

Właściwości

$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

Właściwości dziedziczone

pipeline

Potok używany przez tego klienta do tworzenia żądań

Metody

beginPerformConnectivityCheckAsync(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Przeprowadza sprawdzanie łączności między usługą API Management a danym miejscem docelowym i zwraca metryki dla połączenia, a także błędy napotkane podczas próby jego ustanowienia.

beginPerformConnectivityCheckAsyncAndWait(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Przeprowadza sprawdzanie łączności między usługą API Management a danym miejscem docelowym i zwraca metryki dla połączenia, a także błędy napotkane podczas próby jego ustanowienia.

Metody dziedziczone

sendOperationRequest<T>(OperationArguments, OperationSpec)

Wyślij żądanie HTTP wypełnione przy użyciu podanego elementu OperationSpec.

sendRequest(PipelineRequest)

Wyślij podany element httpRequest.

Szczegóły konstruktora

ApiManagementClient(TokenCredential, ApiManagementClientOptionalParams)

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

Parametry

credentials
TokenCredential

ApiManagementClient(TokenCredential, string, ApiManagementClientOptionalParams)

Inicjuje nowe wystąpienie klasy ApiManagementClient.

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

Parametry

credentials
TokenCredential

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję klienta.

subscriptionId

string

Identyfikator subskrypcji docelowej.

options
ApiManagementClientOptionalParams

Opcje parametrów

Szczegóły właściwości

$host

$host: string

Wartość właściwości

string

api

api: Api

Wartość właściwości

Api

apiDiagnostic

apiDiagnostic: ApiDiagnostic

Wartość właściwości

apiExport

apiExport: ApiExport

Wartość właściwości

apiIssue

apiIssue: ApiIssue

Wartość właściwości

apiIssueAttachment

apiIssueAttachment: ApiIssueAttachment

Wartość właściwości

apiIssueComment

apiIssueComment: ApiIssueComment

Wartość właściwości

apiManagementOperations

apiManagementOperations: ApiManagementOperations

Wartość właściwości

apiManagementService

apiManagementService: ApiManagementService

Wartość właściwości

apiManagementServiceSkus

apiManagementServiceSkus: ApiManagementServiceSkus

Wartość właściwości

apiManagementSkus

apiManagementSkus: ApiManagementSkus

Wartość właściwości

apiOperation

apiOperation: ApiOperation

Wartość właściwości

apiOperationPolicy

apiOperationPolicy: ApiOperationPolicy

Wartość właściwości

apiPolicy

apiPolicy: ApiPolicy

Wartość właściwości

apiProduct

apiProduct: ApiProduct

Wartość właściwości

apiRelease

apiRelease: ApiRelease

Wartość właściwości

apiRevision

apiRevision: ApiRevision

Wartość właściwości

apiSchema

apiSchema: ApiSchema

Wartość właściwości

apiTagDescription

apiTagDescription: ApiTagDescription

Wartość właściwości

apiVersion

apiVersion: string

Wartość właściwości

string

apiVersionSet

apiVersionSet: ApiVersionSet

Wartość właściwości

apiWiki

apiWiki: ApiWiki

Wartość właściwości

apiWikis

apiWikis: ApiWikis

Wartość właściwości

authorization

authorization: Authorization

Wartość właściwości

authorizationAccessPolicy

authorizationAccessPolicy: AuthorizationAccessPolicy

Wartość właściwości

authorizationLoginLinks: AuthorizationLoginLinks

Wartość właściwości

authorizationProvider

authorizationProvider: AuthorizationProvider

Wartość właściwości

authorizationServer

authorizationServer: AuthorizationServer

Wartość właściwości

backend

backend: Backend

Wartość właściwości

cache

cache: Cache_2

Wartość właściwości

certificate

certificate: Certificate

Wartość właściwości

contentItem

contentItem: ContentItem

Wartość właściwości

contentType

contentType: ContentType

Wartość właściwości

delegationSettings

delegationSettings: DelegationSettings

Wartość właściwości

deletedServices

deletedServices: DeletedServices

Wartość właściwości

diagnostic

diagnostic: Diagnostic

Wartość właściwości

documentation

documentation: Documentation

Wartość właściwości

emailTemplate

emailTemplate: EmailTemplate

Wartość właściwości

gateway

gateway: Gateway

Wartość właściwości

gatewayApi

gatewayApi: GatewayApi

Wartość właściwości

gatewayCertificateAuthority

gatewayCertificateAuthority: GatewayCertificateAuthority

Wartość właściwości

gatewayHostnameConfiguration

gatewayHostnameConfiguration: GatewayHostnameConfiguration

Wartość właściwości

globalSchema

globalSchema: GlobalSchema

Wartość właściwości

graphQLApiResolver

graphQLApiResolver: GraphQLApiResolver

Wartość właściwości

graphQLApiResolverPolicy

graphQLApiResolverPolicy: GraphQLApiResolverPolicy

Wartość właściwości

group

group: Group

Wartość właściwości

groupUser

groupUser: GroupUser

Wartość właściwości

identityProvider

identityProvider: IdentityProvider

Wartość właściwości

issue

issue: Issue

Wartość właściwości

logger

logger: Logger

Wartość właściwości

namedValue

namedValue: NamedValue

Wartość właściwości

networkStatus

networkStatus: NetworkStatus

Wartość właściwości

notification

notification: Notification_2

Wartość właściwości

notificationRecipientEmail

notificationRecipientEmail: NotificationRecipientEmail

Wartość właściwości

notificationRecipientUser

notificationRecipientUser: NotificationRecipientUser

Wartość właściwości

openIdConnectProvider

openIdConnectProvider: OpenIdConnectProvider

Wartość właściwości

operationOperations

operationOperations: OperationOperations

Wartość właściwości

outboundNetworkDependenciesEndpoints

outboundNetworkDependenciesEndpoints: OutboundNetworkDependenciesEndpoints

Wartość właściwości

policy

policy: Policy

Wartość właściwości

policyDescription

policyDescription: PolicyDescription

Wartość właściwości

policyFragment

policyFragment: PolicyFragment

Wartość właściwości

portalConfig

portalConfig: PortalConfig

Wartość właściwości

portalRevision

portalRevision: PortalRevision

Wartość właściwości

portalSettings

portalSettings: PortalSettings

Wartość właściwości

privateEndpointConnectionOperations

privateEndpointConnectionOperations: PrivateEndpointConnectionOperations

Wartość właściwości

product

product: Product

Wartość właściwości

productApi

productApi: ProductApi

Wartość właściwości

productGroup

productGroup: ProductGroup

Wartość właściwości

productPolicy

productPolicy: ProductPolicy

Wartość właściwości

productSubscriptions

productSubscriptions: ProductSubscriptions

Wartość właściwości

productWiki

productWiki: ProductWiki

Wartość właściwości

productWikis

productWikis: ProductWikis

Wartość właściwości

quotaByCounterKeys

quotaByCounterKeys: QuotaByCounterKeys

Wartość właściwości

quotaByPeriodKeys

quotaByPeriodKeys: QuotaByPeriodKeys

Wartość właściwości

region

region: Region

Wartość właściwości

reports

reports: Reports

Wartość właściwości

signInSettings

signInSettings: SignInSettings

Wartość właściwości

signUpSettings

signUpSettings: SignUpSettings

Wartość właściwości

subscription

subscription: Subscription

Wartość właściwości

subscriptionId

subscriptionId?: string

Wartość właściwości

string

tag

tag: Tag

Wartość właściwości

Tag

tagResource

tagResource: TagResource

Wartość właściwości

tenantAccess

tenantAccess: TenantAccess

Wartość właściwości

tenantAccessGit

tenantAccessGit: TenantAccessGit

Wartość właściwości

tenantConfiguration

tenantConfiguration: TenantConfiguration

Wartość właściwości

tenantSettings

tenantSettings: TenantSettings

Wartość właściwości

user

user: User

Wartość właściwości

userConfirmationPassword

userConfirmationPassword: UserConfirmationPassword

Wartość właściwości

userGroup

userGroup: UserGroup

Wartość właściwości

userIdentities

userIdentities: UserIdentities

Wartość właściwości

userSubscription

userSubscription: UserSubscription

Wartość właściwości

Szczegóły właściwości dziedziczonej

pipeline

Potok używany przez tego klienta do tworzenia żądań

pipeline: Pipeline

Wartość właściwości

dziedziczone z coreClient.ServiceClient.pipeline

Szczegóły metody

beginPerformConnectivityCheckAsync(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Przeprowadza sprawdzanie łączności między usługą API Management a danym miejscem docelowym i zwraca metryki dla połączenia, a także błędy napotkane podczas próby jego ustanowienia.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

connectivityCheckRequestParams
ConnectivityCheckRequest

Parametry żądania sprawdzania łączności.

Zwraca

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

beginPerformConnectivityCheckAsyncAndWait(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)

Przeprowadza sprawdzanie łączności między usługą API Management a danym miejscem docelowym i zwraca metryki dla połączenia, a także błędy napotkane podczas próby jego ustanowienia.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

connectivityCheckRequestParams
ConnectivityCheckRequest

Parametry żądania sprawdzania łączności.

Zwraca

Szczegóły metody dziedziczonej

sendOperationRequest<T>(OperationArguments, OperationSpec)

Wyślij żądanie HTTP wypełnione przy użyciu podanego elementu OperationSpec.

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

Parametry

operationArguments
OperationArguments

Argumenty, z których zostaną wypełnione wartości szablonowe żądania HTTP.

operationSpec
OperationSpec

Element OperationSpec do użycia w celu wypełnienia żądania httpRequest.

Zwraca

Promise<T>

dziedziczone z coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Wyślij podany element httpRequest.

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

Parametry

request
PipelineRequest

Zwraca

Promise<PipelineResponse>

dziedziczone z coreClient.ServiceClient.sendRequest