ApiManagementClient class
- Extends
Constructors
| Api |
|
| Api |
Initializes a new instance of the ApiManagementClient class. |
Properties
Inherited Properties
| pipeline | The pipeline used by this client to make requests |
Methods
| begin |
Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it. |
| begin |
Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it. |
Inherited Methods
| send |
Send an HTTP request that is populated using the provided OperationSpec. |
| send |
Send the provided httpRequest. |
Constructor Details
ApiManagementClient(TokenCredential, ApiManagementClientOptionalParams)
new ApiManagementClient(credentials: TokenCredential, options?: ApiManagementClientOptionalParams)Parameters
- credentials
- TokenCredential
ApiManagementClient(TokenCredential, string, ApiManagementClientOptionalParams)
Initializes a new instance of the ApiManagementClient class.
new ApiManagementClient(credentials: TokenCredential, subscriptionId: string, options?: ApiManagementClientOptionalParams)Parameters
- credentials
- TokenCredential
Subscription credentials which uniquely identify client subscription.
- subscriptionId
-
string
The ID of the target subscription.
The parameter options
Property Details
$host
$host: stringProperty Value
string
api
apiDiagnostic
apiExport
apiIssue
apiIssueAttachment
apiIssueComment
apiManagementOperations
apiManagementService
apiManagementServiceSkus
apiManagementSkus
apiOperation
apiOperationPolicy
apiPolicy
apiProduct
apiRelease
apiRevision
apiSchema
apiTagDescription
apiVersion
apiVersion: stringProperty Value
string
apiVersionSet
apiWiki
apiWikis
authorization
authorizationAccessPolicy
authorizationLoginLinks
authorizationProvider
authorizationServer
backend
cache
certificate
contentItem
contentType
delegationSettings
deletedServices
diagnostic
documentation
emailTemplate
gateway
gatewayApi
gatewayCertificateAuthority
gatewayHostnameConfiguration
gatewayHostnameConfiguration: GatewayHostnameConfigurationProperty Value
globalSchema
graphQLApiResolver
graphQLApiResolverPolicy
group
groupUser
identityProvider
issue
logger
namedValue
networkStatus
notification
notificationRecipientEmail
notificationRecipientUser
openIdConnectProvider
operationOperations
outboundNetworkDependenciesEndpoints
outboundNetworkDependenciesEndpoints: OutboundNetworkDependenciesEndpointsProperty Value
policy
policyDescription
policyFragment
portalConfig
portalRevision
portalSettings
privateEndpointConnectionOperations
privateEndpointConnectionOperations: PrivateEndpointConnectionOperationsProperty Value
product
productApi
productGroup
productPolicy
productSubscriptions
productWiki
productWikis
quotaByCounterKeys
quotaByPeriodKeys
region
reports
signInSettings
signUpSettings
subscription
subscriptionId
subscriptionId?: stringProperty Value
string
tag
tagResource
tenantAccess
tenantAccessGit
tenantConfiguration
tenantSettings
user
userConfirmationPassword
userGroup
userIdentities
userSubscription
Inherited Property Details
pipeline
The pipeline used by this client to make requests
pipeline: PipelineProperty Value
Inherited From coreClient.ServiceClient.pipeline
Method Details
beginPerformConnectivityCheckAsync(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)
Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.
function beginPerformConnectivityCheckAsync(resourceGroupName: string, serviceName: string, connectivityCheckRequestParams: ConnectivityCheckRequest, options?: PerformConnectivityCheckAsyncOptionalParams): Promise<SimplePollerLike<OperationState<ConnectivityCheckResponse>, ConnectivityCheckResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- connectivityCheckRequestParams
- ConnectivityCheckRequest
Connectivity Check request parameters.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ConnectivityCheckResponse>, ConnectivityCheckResponse>>
beginPerformConnectivityCheckAsyncAndWait(string, string, ConnectivityCheckRequest, PerformConnectivityCheckAsyncOptionalParams)
Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.
function beginPerformConnectivityCheckAsyncAndWait(resourceGroupName: string, serviceName: string, connectivityCheckRequestParams: ConnectivityCheckRequest, options?: PerformConnectivityCheckAsyncOptionalParams): Promise<ConnectivityCheckResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- connectivityCheckRequestParams
- ConnectivityCheckRequest
Connectivity Check request parameters.
The options parameters.
Returns
Promise<ConnectivityCheckResponse>
Inherited Method Details
sendOperationRequest<T>(OperationArguments, OperationSpec)
Send an HTTP request that is populated using the provided OperationSpec.
function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>Parameters
- operationArguments
- OperationArguments
The arguments that the HTTP request's templated values will be populated from.
- operationSpec
- OperationSpec
The OperationSpec to use to populate the httpRequest.
Returns
Promise<T>
Inherited From coreClient.ServiceClient.sendOperationRequest
sendRequest(PipelineRequest)
Send the provided httpRequest.
function sendRequest(request: PipelineRequest): Promise<PipelineResponse>Parameters
- request
- PipelineRequest
Returns
Promise<PipelineResponse>
Inherited From coreClient.ServiceClient.sendRequest