ApiManagementClient Class

Reference

Definition

Namespace:: Microsoft.Azure.Management.ApiManagement

Assembly:: Microsoft.Azure.Management.ApiManagement.dll

Package:: Microsoft.Azure.Management.ApiManagement v8.0.0-preview

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

ApiManagement Client

public class ApiManagementClient : Microsoft.Rest.ServiceClient<Microsoft.Azure.Management.ApiManagement.ApiManagementClient>, IDisposable, Microsoft.Azure.Management.ApiManagement.IApiManagementClient, Microsoft.Rest.Azure.IAzureClient

type ApiManagementClient = class
    inherit ServiceClient<ApiManagementClient>
    interface IApiManagementClient
    interface IDisposable
    interface IAzureClient

Public Class ApiManagementClient
Inherits ServiceClient(Of ApiManagementClient)
Implements IApiManagementClient, IAzureClient, IDisposable

Inheritance: Object

ServiceClient<ApiManagementClient>
ApiManagementClient

Implements: IApiManagementClient IAzureClient IDisposable

Constructors

ApiManagementClient(DelegatingHandler[])	Initializes a new instance of the ApiManagementClient class.
ApiManagementClient(HttpClient, Boolean)	Initializes a new instance of the ApiManagementClient class.
ApiManagementClient(HttpClientHandler, DelegatingHandler[])	Initializes a new instance of the ApiManagementClient class.
ApiManagementClient(ServiceClientCredentials, DelegatingHandler[])	Initializes a new instance of the ApiManagementClient class.
ApiManagementClient(ServiceClientCredentials, HttpClient, Boolean)	Initializes a new instance of the ApiManagementClient class.
ApiManagementClient(ServiceClientCredentials, HttpClientHandler, DelegatingHandler[])	Initializes a new instance of the ApiManagementClient class.
ApiManagementClient(Uri, DelegatingHandler[])	Initializes a new instance of the ApiManagementClient class.
ApiManagementClient(Uri, HttpClientHandler, DelegatingHandler[])	Initializes a new instance of the ApiManagementClient class.
ApiManagementClient(Uri, ServiceClientCredentials, DelegatingHandler[])	Initializes a new instance of the ApiManagementClient class.
ApiManagementClient(Uri, ServiceClientCredentials, HttpClientHandler, DelegatingHandler[])	Initializes a new instance of the ApiManagementClient class.

Properties

AcceptLanguage	The preferred language for the response.
Api	Gets the IApiOperations.
ApiDiagnostic	Gets the IApiDiagnosticOperations.
ApiExport	Gets the IApiExportOperations.
ApiIssue	Gets the IApiIssueOperations.
ApiIssueAttachment	Gets the IApiIssueAttachmentOperations.
ApiIssueComment	Gets the IApiIssueCommentOperations.
ApiManagementOperations	Gets the IApiManagementOperations.
ApiManagementService	Gets the IApiManagementServiceOperations.
ApiManagementServiceSkus	Gets the IApiManagementServiceSkusOperations.
ApiManagementSkus	Gets the IApiManagementSkusOperations.
ApiOperation	Gets the IApiOperationOperations.
ApiOperationPolicy	Gets the IApiOperationPolicyOperations.
ApiPolicy	Gets the IApiPolicyOperations.
ApiProduct	Gets the IApiProductOperations.
ApiRelease	Gets the IApiReleaseOperations.
ApiRevision	Gets the IApiRevisionOperations.
ApiSchema	Gets the IApiSchemaOperations.
ApiTagDescription	Gets the IApiTagDescriptionOperations.
ApiVersion	Version of the API to be used with the client request.
ApiVersionSet	Gets the IApiVersionSetOperations.
AuthorizationServer	Gets the IAuthorizationServerOperations.
Backend	Gets the IBackendOperations.
BaseUri	The base URI of the service.
Cache	Gets the ICacheOperations.
Certificate	Gets the ICertificateOperations.
ContentItem	Gets the IContentItemOperations.
ContentType	Gets the IContentTypeOperations.
Credentials	Credentials needed for the client to connect to Azure.
DelegationSettings	Gets the IDelegationSettingsOperations.
DeletedServices	Gets the IDeletedServicesOperations.
DeserializationSettings	Gets or sets json deserialization settings.
Diagnostic	Gets the IDiagnosticOperations.
EmailTemplate	Gets the IEmailTemplateOperations.
FirstMessageHandler	(Inherited from ServiceClient<T>)
Gateway	Gets the IGatewayOperations.
GatewayApi	Gets the IGatewayApiOperations.
GatewayCertificateAuthority	Gets the IGatewayCertificateAuthorityOperations.
GatewayHostnameConfiguration	Gets the IGatewayHostnameConfigurationOperations.
GenerateClientRequestId	Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.
GlobalSchema	Gets the IGlobalSchemaOperations.
Group	Gets the IGroupOperations.
GroupUser	Gets the IGroupUserOperations.
HttpClient	(Inherited from ServiceClient<T>)
HttpClientHandler	(Inherited from ServiceClient<T>)
HttpMessageHandlers	(Inherited from ServiceClient<T>)
IdentityProvider	Gets the IIdentityProviderOperations.
Issue	Gets the IIssueOperations.
Logger	Gets the ILoggerOperations.
LongRunningOperationRetryTimeout	The retry timeout in seconds for Long Running Operations. Default value is 30.
NamedValue	Gets the INamedValueOperations.
NetworkStatus	Gets the INetworkStatusOperations.
Notification	Gets the INotificationOperations.
NotificationRecipientEmail	Gets the INotificationRecipientEmailOperations.
NotificationRecipientUser	Gets the INotificationRecipientUserOperations.
OpenIdConnectProvider	Gets the IOpenIdConnectProviderOperations.
Operation	Gets the IOperationOperations.
OutboundNetworkDependenciesEndpoints	Gets the IOutboundNetworkDependenciesEndpointsOperations.
Policy	Gets the IPolicyOperations.
PolicyDescription	Gets the IPolicyDescriptionOperations.
PortalRevision	Gets the IPortalRevisionOperations.
PortalSettings	Gets the IPortalSettingsOperations.
PrivateEndpointConnection	Gets the IPrivateEndpointConnectionOperations.
Product	Gets the IProductOperations.
ProductApi	Gets the IProductApiOperations.
ProductGroup	Gets the IProductGroupOperations.
ProductPolicy	Gets the IProductPolicyOperations.
ProductSubscriptions	Gets the IProductSubscriptionsOperations.
QuotaByCounterKeys	Gets the IQuotaByCounterKeysOperations.
QuotaByPeriodKeys	Gets the IQuotaByPeriodKeysOperations.
Region	Gets the IRegionOperations.
Reports	Gets the IReportsOperations.
SerializationSettings	Gets or sets json serialization settings.
SignInSettings	Gets the ISignInSettingsOperations.
SignUpSettings	Gets the ISignUpSettingsOperations.
Subscription	Gets the ISubscriptionOperations.
SubscriptionId	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Tag	Gets the ITagOperations.
TagResource	Gets the ITagResourceOperations.
TenantAccess	Gets the ITenantAccessOperations.
TenantAccessGit	Gets the ITenantAccessGitOperations.
TenantConfiguration	Gets the ITenantConfigurationOperations.
TenantSettings	Gets the ITenantSettingsOperations.
User	Gets the IUserOperations.
UserAgent	(Inherited from ServiceClient<T>)
UserConfirmationPassword	Gets the IUserConfirmationPasswordOperations.
UserGroup	Gets the IUserGroupOperations.
UserIdentities	Gets the IUserIdentitiesOperations.
UserSubscription	Gets the IUserSubscriptionOperations.

Methods

BeginPerformConnectivityCheckAsyncWithHttpMessagesAsync(String, String, ConnectivityCheckRequest, Dictionary<String,List<String>>, CancellationToken)	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.
CreateHttpHandlerPipeline(HttpClientHandler, DelegatingHandler[])	(Inherited from ServiceClient<T>)
Dispose()	(Inherited from ServiceClient<T>)
Dispose(Boolean)	(Inherited from ServiceClient<T>)
InitializeHttpClient(HttpClient, HttpClientHandler, DelegatingHandler[])	(Inherited from ServiceClient<T>)
InitializeHttpClient(HttpClientHandler, DelegatingHandler[])	(Inherited from ServiceClient<T>)
PerformConnectivityCheckAsyncWithHttpMessagesAsync(String, String, ConnectivityCheckRequest, Dictionary<String,List<String>>, CancellationToken)	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.
SetRetryPolicy(RetryPolicy)	(Inherited from ServiceClient<T>)
SetUserAgent(String)	(Inherited from ServiceClient<T>)
SetUserAgent(String, String)	(Inherited from ServiceClient<T>)

Extension Methods

BeginPerformConnectivityCheckAsync(IApiManagementClient, String, String, ConnectivityCheckRequest)	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.
BeginPerformConnectivityCheckAsyncAsync(IApiManagementClient, String, String, ConnectivityCheckRequest, CancellationToken)	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.
PerformConnectivityCheckAsync(IApiManagementClient, String, String, ConnectivityCheckRequest)	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.
PerformConnectivityCheckAsyncAsync(IApiManagementClient, String, String, ConnectivityCheckRequest, CancellationToken)	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.

Applies to