@azure/arm-apimanagement package

Classes

ApiManagementClient

Interfaces

AccessInformationCollection

Paged AccessInformation list representation.

AccessInformationContract

Tenant Settings.

AccessInformationCreateParameters

Tenant access information update parameters.

AccessInformationSecretsContract

Tenant access information contract of the API Management service.

AccessInformationUpdateParameters

Tenant access information update parameters.

AdditionalLocation

Description of an additional API Management resource location.

Api

Interface representing a Api.

ApiCollection

Paged API list representation.

ApiContactInformation

API contact information

ApiContract

API details.

ApiContractProperties

API Entity Properties

ApiContractUpdateProperties

API update contract properties.

ApiCreateOrUpdateHeaders

Defines headers for Api_createOrUpdate operation.

ApiCreateOrUpdateOptionalParams

Optional parameters.

ApiCreateOrUpdateParameter

API Create or Update Parameters.

ApiCreateOrUpdateProperties

API Create or Update Properties.

ApiCreateOrUpdatePropertiesWsdlSelector

Criteria to limit import of WSDL to a subset of the document.

ApiDeleteOptionalParams

Optional parameters.

ApiDiagnostic

Interface representing a ApiDiagnostic.

ApiDiagnosticCreateOrUpdateHeaders

Defines headers for ApiDiagnostic_createOrUpdate operation.

ApiDiagnosticCreateOrUpdateOptionalParams

Optional parameters.

ApiDiagnosticDeleteOptionalParams

Optional parameters.

ApiDiagnosticGetEntityTagHeaders

Defines headers for ApiDiagnostic_getEntityTag operation.

ApiDiagnosticGetEntityTagOptionalParams

Optional parameters.

ApiDiagnosticGetHeaders

Defines headers for ApiDiagnostic_get operation.

ApiDiagnosticGetOptionalParams

Optional parameters.

ApiDiagnosticListByServiceNextOptionalParams

Optional parameters.

ApiDiagnosticListByServiceOptionalParams

Optional parameters.

ApiDiagnosticUpdateHeaders

Defines headers for ApiDiagnostic_update operation.

ApiDiagnosticUpdateOptionalParams

Optional parameters.

ApiEntityBaseContract

API base contract details.

ApiExport

Interface representing a ApiExport.

ApiExportGetOptionalParams

Optional parameters.

ApiExportResult

API Export result.

ApiExportResultValue

The object defining the schema of the exported API Detail

ApiGetEntityTagHeaders

Defines headers for Api_getEntityTag operation.

ApiGetEntityTagOptionalParams

Optional parameters.

ApiGetHeaders

Defines headers for Api_get operation.

ApiGetOptionalParams

Optional parameters.

ApiIssue

Interface representing a ApiIssue.

ApiIssueAttachment

Interface representing a ApiIssueAttachment.

ApiIssueAttachmentCreateOrUpdateHeaders

Defines headers for ApiIssueAttachment_createOrUpdate operation.

ApiIssueAttachmentCreateOrUpdateOptionalParams

Optional parameters.

ApiIssueAttachmentDeleteOptionalParams

Optional parameters.

ApiIssueAttachmentGetEntityTagHeaders

Defines headers for ApiIssueAttachment_getEntityTag operation.

ApiIssueAttachmentGetEntityTagOptionalParams

Optional parameters.

ApiIssueAttachmentGetHeaders

Defines headers for ApiIssueAttachment_get operation.

ApiIssueAttachmentGetOptionalParams

Optional parameters.

ApiIssueAttachmentListByServiceNextOptionalParams

Optional parameters.

ApiIssueAttachmentListByServiceOptionalParams

Optional parameters.

ApiIssueComment

Interface representing a ApiIssueComment.

ApiIssueCommentCreateOrUpdateHeaders

Defines headers for ApiIssueComment_createOrUpdate operation.

ApiIssueCommentCreateOrUpdateOptionalParams

Optional parameters.

ApiIssueCommentDeleteOptionalParams

Optional parameters.

ApiIssueCommentGetEntityTagHeaders

Defines headers for ApiIssueComment_getEntityTag operation.

ApiIssueCommentGetEntityTagOptionalParams

Optional parameters.

ApiIssueCommentGetHeaders

Defines headers for ApiIssueComment_get operation.

ApiIssueCommentGetOptionalParams

Optional parameters.

ApiIssueCommentListByServiceNextOptionalParams

Optional parameters.

ApiIssueCommentListByServiceOptionalParams

Optional parameters.

ApiIssueCreateOrUpdateHeaders

Defines headers for ApiIssue_createOrUpdate operation.

ApiIssueCreateOrUpdateOptionalParams

Optional parameters.

ApiIssueDeleteOptionalParams

Optional parameters.

ApiIssueGetEntityTagHeaders

Defines headers for ApiIssue_getEntityTag operation.

ApiIssueGetEntityTagOptionalParams

Optional parameters.

ApiIssueGetHeaders

Defines headers for ApiIssue_get operation.

ApiIssueGetOptionalParams

Optional parameters.

ApiIssueListByServiceNextOptionalParams

Optional parameters.

ApiIssueListByServiceOptionalParams

Optional parameters.

ApiIssueUpdateHeaders

Defines headers for ApiIssue_update operation.

ApiIssueUpdateOptionalParams

Optional parameters.

ApiLicenseInformation

API license information

ApiListByServiceNextOptionalParams

Optional parameters.

ApiListByServiceOptionalParams

Optional parameters.

ApiListByTagsNextOptionalParams

Optional parameters.

ApiListByTagsOptionalParams

Optional parameters.

ApiManagementClientOptionalParams

Optional parameters.

ApiManagementOperations

Interface representing a ApiManagementOperations.

ApiManagementOperationsListNextOptionalParams

Optional parameters.

ApiManagementOperationsListOptionalParams

Optional parameters.

ApiManagementService

Interface representing a ApiManagementService.

ApiManagementServiceApplyNetworkConfigurationParameters

Parameter supplied to the Apply Network configuration operation.

ApiManagementServiceApplyNetworkConfigurationUpdatesHeaders

Defines headers for ApiManagementService_applyNetworkConfigurationUpdates operation.

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Optional parameters.

ApiManagementServiceBackupHeaders

Defines headers for ApiManagementService_backup operation.

ApiManagementServiceBackupOptionalParams

Optional parameters.

ApiManagementServiceBackupRestoreParameters

Parameters supplied to the Backup/Restore of an API Management service operation.

ApiManagementServiceBaseProperties

Base Properties of an API Management service resource description.

ApiManagementServiceCheckNameAvailabilityOptionalParams

Optional parameters.

ApiManagementServiceCheckNameAvailabilityParameters

Parameters supplied to the CheckNameAvailability operation.

ApiManagementServiceCreateOrUpdateOptionalParams

Optional parameters.

ApiManagementServiceDeleteOptionalParams

Optional parameters.

ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams

Optional parameters.

ApiManagementServiceGetDomainOwnershipIdentifierResult

Response of the GetDomainOwnershipIdentifier operation.

ApiManagementServiceGetOptionalParams

Optional parameters.

ApiManagementServiceGetSsoTokenOptionalParams

Optional parameters.

ApiManagementServiceGetSsoTokenResult

The response of the GetSsoToken operation.

ApiManagementServiceIdentity

Identity properties of the Api Management service resource.

ApiManagementServiceListByResourceGroupNextOptionalParams

Optional parameters.

ApiManagementServiceListByResourceGroupOptionalParams

Optional parameters.

ApiManagementServiceListNextOptionalParams

Optional parameters.

ApiManagementServiceListOptionalParams

Optional parameters.

ApiManagementServiceListResult

The response of the List API Management services operation.

ApiManagementServiceMigrateToStv2Headers

Defines headers for ApiManagementService_migrateToStv2 operation.

ApiManagementServiceMigrateToStv2OptionalParams

Optional parameters.

ApiManagementServiceNameAvailabilityResult

Response of the CheckNameAvailability operation.

ApiManagementServiceProperties

Properties of an API Management service resource description.

ApiManagementServiceResource

A single API Management service resource in List or Get response.

ApiManagementServiceRestoreHeaders

Defines headers for ApiManagementService_restore operation.

ApiManagementServiceRestoreOptionalParams

Optional parameters.

ApiManagementServiceSkuProperties

API Management service resource SKU properties.

ApiManagementServiceSkus

Interface representing a ApiManagementServiceSkus.

ApiManagementServiceSkusListAvailableServiceSkusNextOptionalParams

Optional parameters.

ApiManagementServiceSkusListAvailableServiceSkusOptionalParams

Optional parameters.

ApiManagementServiceUpdateOptionalParams

Optional parameters.

ApiManagementServiceUpdateParameters

Parameter supplied to Update Api Management Service.

ApiManagementServiceUpdateProperties

Properties of an API Management service resource description.

ApiManagementSku

Describes an available ApiManagement SKU.

ApiManagementSkuCapabilities

Describes The SKU capabilities object.

ApiManagementSkuCapacity

Describes scaling information of a SKU.

ApiManagementSkuCosts

Describes metadata for retrieving price info.

ApiManagementSkuLocationInfo
ApiManagementSkuRestrictionInfo
ApiManagementSkuRestrictions

Describes scaling information of a SKU.

ApiManagementSkuZoneDetails

Describes The zonal capabilities of a SKU.

ApiManagementSkus

Interface representing a ApiManagementSkus.

ApiManagementSkusListNextOptionalParams

Optional parameters.

ApiManagementSkusListOptionalParams

Optional parameters.

ApiManagementSkusResult

The List Resource Skus operation response.

ApiOperation

Interface representing a ApiOperation.

ApiOperationCreateOrUpdateHeaders

Defines headers for ApiOperation_createOrUpdate operation.

ApiOperationCreateOrUpdateOptionalParams

Optional parameters.

ApiOperationDeleteOptionalParams

Optional parameters.

ApiOperationGetEntityTagHeaders

Defines headers for ApiOperation_getEntityTag operation.

ApiOperationGetEntityTagOptionalParams

Optional parameters.

ApiOperationGetHeaders

Defines headers for ApiOperation_get operation.

ApiOperationGetOptionalParams

Optional parameters.

ApiOperationListByApiNextOptionalParams

Optional parameters.

ApiOperationListByApiOptionalParams

Optional parameters.

ApiOperationPolicy

Interface representing a ApiOperationPolicy.

ApiOperationPolicyCreateOrUpdateHeaders

Defines headers for ApiOperationPolicy_createOrUpdate operation.

ApiOperationPolicyCreateOrUpdateOptionalParams

Optional parameters.

ApiOperationPolicyDeleteOptionalParams

Optional parameters.

ApiOperationPolicyGetEntityTagHeaders

Defines headers for ApiOperationPolicy_getEntityTag operation.

ApiOperationPolicyGetEntityTagOptionalParams

Optional parameters.

ApiOperationPolicyGetHeaders

Defines headers for ApiOperationPolicy_get operation.

ApiOperationPolicyGetOptionalParams

Optional parameters.

ApiOperationPolicyListByOperationOptionalParams

Optional parameters.

ApiOperationUpdateHeaders

Defines headers for ApiOperation_update operation.

ApiOperationUpdateOptionalParams

Optional parameters.

ApiPolicy

Interface representing a ApiPolicy.

ApiPolicyCreateOrUpdateHeaders

Defines headers for ApiPolicy_createOrUpdate operation.

ApiPolicyCreateOrUpdateOptionalParams

Optional parameters.

ApiPolicyDeleteOptionalParams

Optional parameters.

ApiPolicyGetEntityTagHeaders

Defines headers for ApiPolicy_getEntityTag operation.

ApiPolicyGetEntityTagOptionalParams

Optional parameters.

ApiPolicyGetHeaders

Defines headers for ApiPolicy_get operation.

ApiPolicyGetOptionalParams

Optional parameters.

ApiPolicyListByApiOptionalParams

Optional parameters.

ApiProduct

Interface representing a ApiProduct.

ApiProductListByApisNextOptionalParams

Optional parameters.

ApiProductListByApisOptionalParams

Optional parameters.

ApiRelease

Interface representing a ApiRelease.

ApiReleaseCollection

Paged ApiRelease list representation.

ApiReleaseContract

ApiRelease details.

ApiReleaseCreateOrUpdateHeaders

Defines headers for ApiRelease_createOrUpdate operation.

ApiReleaseCreateOrUpdateOptionalParams

Optional parameters.

ApiReleaseDeleteOptionalParams

Optional parameters.

ApiReleaseGetEntityTagHeaders

Defines headers for ApiRelease_getEntityTag operation.

ApiReleaseGetEntityTagOptionalParams

Optional parameters.

ApiReleaseGetHeaders

Defines headers for ApiRelease_get operation.

ApiReleaseGetOptionalParams

Optional parameters.

ApiReleaseListByServiceNextOptionalParams

Optional parameters.

ApiReleaseListByServiceOptionalParams

Optional parameters.

ApiReleaseUpdateHeaders

Defines headers for ApiRelease_update operation.

ApiReleaseUpdateOptionalParams

Optional parameters.

ApiRevision

Interface representing a ApiRevision.

ApiRevisionCollection

Paged API Revision list representation.

ApiRevisionContract

Summary of revision metadata.

ApiRevisionInfoContract

Object used to create an API Revision or Version based on an existing API Revision

ApiRevisionListByServiceNextOptionalParams

Optional parameters.

ApiRevisionListByServiceOptionalParams

Optional parameters.

ApiSchema

Interface representing a ApiSchema.

ApiSchemaCreateOrUpdateHeaders

Defines headers for ApiSchema_createOrUpdate operation.

ApiSchemaCreateOrUpdateOptionalParams

Optional parameters.

ApiSchemaDeleteOptionalParams

Optional parameters.

ApiSchemaGetEntityTagHeaders

Defines headers for ApiSchema_getEntityTag operation.

ApiSchemaGetEntityTagOptionalParams

Optional parameters.

ApiSchemaGetHeaders

Defines headers for ApiSchema_get operation.

ApiSchemaGetOptionalParams

Optional parameters.

ApiSchemaListByApiNextOptionalParams

Optional parameters.

ApiSchemaListByApiOptionalParams

Optional parameters.

ApiTagDescription

Interface representing a ApiTagDescription.

ApiTagDescriptionCreateOrUpdateHeaders

Defines headers for ApiTagDescription_createOrUpdate operation.

ApiTagDescriptionCreateOrUpdateOptionalParams

Optional parameters.

ApiTagDescriptionDeleteOptionalParams

Optional parameters.

ApiTagDescriptionGetEntityTagHeaders

Defines headers for ApiTagDescription_getEntityTag operation.

ApiTagDescriptionGetEntityTagOptionalParams

Optional parameters.

ApiTagDescriptionGetHeaders

Defines headers for ApiTagDescription_get operation.

ApiTagDescriptionGetOptionalParams

Optional parameters.

ApiTagDescriptionListByServiceNextOptionalParams

Optional parameters.

ApiTagDescriptionListByServiceOptionalParams

Optional parameters.

ApiTagResourceContractProperties

API contract properties for the Tag Resources.

ApiUpdateContract

API update contract details.

ApiUpdateHeaders

Defines headers for Api_update operation.

ApiUpdateOptionalParams

Optional parameters.

ApiVersionConstraint

Control Plane Apis version constraint for the API Management service.

ApiVersionSet

Interface representing a ApiVersionSet.

ApiVersionSetCollection

Paged API Version Set list representation.

ApiVersionSetContract

API Version Set Contract details.

ApiVersionSetContractDetails

An API Version Set contains the common configuration for a set of API Versions relating

ApiVersionSetContractProperties

Properties of an API Version Set.

ApiVersionSetCreateOrUpdateHeaders

Defines headers for ApiVersionSet_createOrUpdate operation.

ApiVersionSetCreateOrUpdateOptionalParams

Optional parameters.

ApiVersionSetDeleteOptionalParams

Optional parameters.

ApiVersionSetEntityBase

API Version set base parameters

ApiVersionSetGetEntityTagHeaders

Defines headers for ApiVersionSet_getEntityTag operation.

ApiVersionSetGetEntityTagOptionalParams

Optional parameters.

ApiVersionSetGetHeaders

Defines headers for ApiVersionSet_get operation.

ApiVersionSetGetOptionalParams

Optional parameters.

ApiVersionSetListByServiceNextOptionalParams

Optional parameters.

ApiVersionSetListByServiceOptionalParams

Optional parameters.

ApiVersionSetUpdateHeaders

Defines headers for ApiVersionSet_update operation.

ApiVersionSetUpdateOptionalParams

Optional parameters.

ApiVersionSetUpdateParameters

Parameters to update or create an API Version Set Contract.

ApiVersionSetUpdateParametersProperties

Properties used to create or update an API Version Set.

ApiWiki

Interface representing a ApiWiki.

ApiWikiCreateOrUpdateHeaders

Defines headers for ApiWiki_createOrUpdate operation.

ApiWikiCreateOrUpdateOptionalParams

Optional parameters.

ApiWikiDeleteOptionalParams

Optional parameters.

ApiWikiGetEntityTagHeaders

Defines headers for ApiWiki_getEntityTag operation.

ApiWikiGetEntityTagOptionalParams

Optional parameters.

ApiWikiGetHeaders

Defines headers for ApiWiki_get operation.

ApiWikiGetOptionalParams

Optional parameters.

ApiWikiUpdateHeaders

Defines headers for ApiWiki_update operation.

ApiWikiUpdateOptionalParams

Optional parameters.

ApiWikis

Interface representing a ApiWikis.

ApiWikisListNextOptionalParams

Optional parameters.

ApiWikisListOptionalParams

Optional parameters.

ApimResource

The Resource definition.

ArmIdWrapper

A wrapper for an ARM resource id

AssociationContract

Association entity details.

AuthenticationSettingsContract

API Authentication Settings.

Authorization

Interface representing a Authorization.

AuthorizationAccessPolicy

Interface representing a AuthorizationAccessPolicy.

AuthorizationAccessPolicyCollection

Paged Authorization Access Policy list representation.

AuthorizationAccessPolicyContract

Authorization access policy contract.

AuthorizationAccessPolicyCreateOrUpdateHeaders

Defines headers for AuthorizationAccessPolicy_createOrUpdate operation.

AuthorizationAccessPolicyCreateOrUpdateOptionalParams

Optional parameters.

AuthorizationAccessPolicyDeleteOptionalParams

Optional parameters.

AuthorizationAccessPolicyGetHeaders

Defines headers for AuthorizationAccessPolicy_get operation.

AuthorizationAccessPolicyGetOptionalParams

Optional parameters.

AuthorizationAccessPolicyListByAuthorizationNextOptionalParams

Optional parameters.

AuthorizationAccessPolicyListByAuthorizationOptionalParams

Optional parameters.

AuthorizationCollection

Paged Authorization list representation.

AuthorizationConfirmConsentCodeHeaders

Defines headers for Authorization_confirmConsentCode operation.

AuthorizationConfirmConsentCodeOptionalParams

Optional parameters.

AuthorizationConfirmConsentCodeRequestContract

Authorization confirm consent code request contract.

AuthorizationContract

Authorization contract.

AuthorizationCreateOrUpdateHeaders

Defines headers for Authorization_createOrUpdate operation.

AuthorizationCreateOrUpdateOptionalParams

Optional parameters.

AuthorizationDeleteOptionalParams

Optional parameters.

AuthorizationError

Authorization error details.

AuthorizationGetHeaders

Defines headers for Authorization_get operation.

AuthorizationGetOptionalParams

Optional parameters.

AuthorizationListByAuthorizationProviderNextOptionalParams

Optional parameters.

AuthorizationListByAuthorizationProviderOptionalParams

Optional parameters.

AuthorizationLoginLinks

Interface representing a AuthorizationLoginLinks.

AuthorizationLoginLinksPostHeaders

Defines headers for AuthorizationLoginLinks_post operation.

AuthorizationLoginLinksPostOptionalParams

Optional parameters.

AuthorizationLoginRequestContract

Authorization login request contract.

AuthorizationLoginResponseContract

Authorization login response contract.

AuthorizationProvider

Interface representing a AuthorizationProvider.

AuthorizationProviderCollection

Paged Authorization Provider list representation.

AuthorizationProviderContract

Authorization Provider contract.

AuthorizationProviderCreateOrUpdateHeaders

Defines headers for AuthorizationProvider_createOrUpdate operation.

AuthorizationProviderCreateOrUpdateOptionalParams

Optional parameters.

AuthorizationProviderDeleteOptionalParams

Optional parameters.

AuthorizationProviderGetHeaders

Defines headers for AuthorizationProvider_get operation.

AuthorizationProviderGetOptionalParams

Optional parameters.

AuthorizationProviderListByServiceNextOptionalParams

Optional parameters.

AuthorizationProviderListByServiceOptionalParams

Optional parameters.

AuthorizationProviderOAuth2GrantTypes

Authorization Provider oauth2 grant types settings

AuthorizationProviderOAuth2Settings

OAuth2 settings details

AuthorizationServer

Interface representing a AuthorizationServer.

AuthorizationServerCollection

Paged OAuth2 Authorization Servers list representation.

AuthorizationServerContract

External OAuth authorization server settings.

AuthorizationServerContractBaseProperties

External OAuth authorization server Update settings contract.

AuthorizationServerContractProperties

External OAuth authorization server settings Properties.

AuthorizationServerCreateOrUpdateHeaders

Defines headers for AuthorizationServer_createOrUpdate operation.

AuthorizationServerCreateOrUpdateOptionalParams

Optional parameters.

AuthorizationServerDeleteOptionalParams

Optional parameters.

AuthorizationServerGetEntityTagHeaders

Defines headers for AuthorizationServer_getEntityTag operation.

AuthorizationServerGetEntityTagOptionalParams

Optional parameters.

AuthorizationServerGetHeaders

Defines headers for AuthorizationServer_get operation.

AuthorizationServerGetOptionalParams

Optional parameters.

AuthorizationServerListByServiceNextOptionalParams

Optional parameters.

AuthorizationServerListByServiceOptionalParams

Optional parameters.

AuthorizationServerListSecretsHeaders

Defines headers for AuthorizationServer_listSecrets operation.

AuthorizationServerListSecretsOptionalParams

Optional parameters.

AuthorizationServerSecretsContract

OAuth Server Secrets Contract.

AuthorizationServerUpdateContract

External OAuth authorization server settings.

AuthorizationServerUpdateContractProperties

External OAuth authorization server Update settings contract.

AuthorizationServerUpdateHeaders

Defines headers for AuthorizationServer_update operation.

AuthorizationServerUpdateOptionalParams

Optional parameters.

Backend

Interface representing a Backend.

BackendAuthorizationHeaderCredentials

Authorization header information.

BackendBaseParameters

Backend entity base Parameter set.

BackendCollection

Paged Backend list representation.

BackendContract

Backend details.

BackendContractProperties

Parameters supplied to the Create Backend operation.

BackendCreateOrUpdateHeaders

Defines headers for Backend_createOrUpdate operation.

BackendCreateOrUpdateOptionalParams

Optional parameters.

BackendCredentialsContract

Details of the Credentials used to connect to Backend.

BackendDeleteOptionalParams

Optional parameters.

BackendGetEntityTagHeaders

Defines headers for Backend_getEntityTag operation.

BackendGetEntityTagOptionalParams

Optional parameters.

BackendGetHeaders

Defines headers for Backend_get operation.

BackendGetOptionalParams

Optional parameters.

BackendListByServiceNextOptionalParams

Optional parameters.

BackendListByServiceOptionalParams

Optional parameters.

BackendProperties

Properties specific to the Backend Type.

BackendProxyContract

Details of the Backend WebProxy Server to use in the Request to Backend.

BackendReconnectContract

Reconnect request parameters.

BackendReconnectOptionalParams

Optional parameters.

BackendServiceFabricClusterProperties

Properties of the Service Fabric Type Backend.

BackendTlsProperties

Properties controlling TLS Certificate Validation.

BackendUpdateHeaders

Defines headers for Backend_update operation.

BackendUpdateOptionalParams

Optional parameters.

BackendUpdateParameterProperties

Parameters supplied to the Update Backend operation.

BackendUpdateParameters

Backend update parameters.

BodyDiagnosticSettings

Body logging settings.

Cache

Interface representing a Cache.

CacheCollection

Paged Caches list representation.

CacheContract

Cache details.

CacheCreateOrUpdateHeaders

Defines headers for Cache_createOrUpdate operation.

CacheCreateOrUpdateOptionalParams

Optional parameters.

CacheDeleteOptionalParams

Optional parameters.

CacheGetEntityTagHeaders

Defines headers for Cache_getEntityTag operation.

CacheGetEntityTagOptionalParams

Optional parameters.

CacheGetHeaders

Defines headers for Cache_get operation.

CacheGetOptionalParams

Optional parameters.

CacheListByServiceNextOptionalParams

Optional parameters.

CacheListByServiceOptionalParams

Optional parameters.

CacheUpdateHeaders

Defines headers for Cache_update operation.

CacheUpdateOptionalParams

Optional parameters.

CacheUpdateParameters

Cache update details.

Certificate

Interface representing a Certificate.

CertificateCollection

Paged Certificates list representation.

CertificateConfiguration

Certificate configuration which consist of non-trusted intermediates and root certificates.

CertificateContract

Certificate details.

CertificateCreateOrUpdateHeaders

Defines headers for Certificate_createOrUpdate operation.

CertificateCreateOrUpdateOptionalParams

Optional parameters.

CertificateCreateOrUpdateParameters

Certificate create or update details.

CertificateDeleteOptionalParams

Optional parameters.

CertificateGetEntityTagHeaders

Defines headers for Certificate_getEntityTag operation.

CertificateGetEntityTagOptionalParams

Optional parameters.

CertificateGetHeaders

Defines headers for Certificate_get operation.

CertificateGetOptionalParams

Optional parameters.

CertificateInformation

SSL certificate information.

CertificateListByServiceNextOptionalParams

Optional parameters.

CertificateListByServiceOptionalParams

Optional parameters.

CertificateRefreshSecretHeaders

Defines headers for Certificate_refreshSecret operation.

CertificateRefreshSecretOptionalParams

Optional parameters.

ClientSecretContract

Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

ConnectivityCheckRequest

A request to perform the connectivity check operation on a API Management service.

ConnectivityCheckRequestDestination

The connectivity check operation destination.

ConnectivityCheckRequestProtocolConfiguration

Protocol-specific configuration.

ConnectivityCheckRequestProtocolConfigurationHttpConfiguration

Configuration for HTTP or HTTPS requests.

ConnectivityCheckRequestSource

Definitions about the connectivity check origin.

ConnectivityCheckResponse

Information on the connectivity status.

ConnectivityHop

Information about a hop between the source and the destination.

ConnectivityIssue

Information about an issue encountered in the process of checking for connectivity.

ConnectivityStatusContract

Details about connectivity to a resource.

ContentItem

Interface representing a ContentItem.

ContentItemCollection

Paged list of content items.

ContentItemContract

Content type contract details.

ContentItemCreateOrUpdateHeaders

Defines headers for ContentItem_createOrUpdate operation.

ContentItemCreateOrUpdateOptionalParams

Optional parameters.

ContentItemDeleteOptionalParams

Optional parameters.

ContentItemGetEntityTagHeaders

Defines headers for ContentItem_getEntityTag operation.

ContentItemGetEntityTagOptionalParams

Optional parameters.

ContentItemGetHeaders

Defines headers for ContentItem_get operation.

ContentItemGetOptionalParams

Optional parameters.

ContentItemListByServiceNextOptionalParams

Optional parameters.

ContentItemListByServiceOptionalParams

Optional parameters.

ContentType

Interface representing a ContentType.

ContentTypeCollection

Paged list of content types.

ContentTypeContract

Content type contract details.

ContentTypeCreateOrUpdateHeaders

Defines headers for ContentType_createOrUpdate operation.

ContentTypeCreateOrUpdateOptionalParams

Optional parameters.

ContentTypeDeleteOptionalParams

Optional parameters.

ContentTypeGetHeaders

Defines headers for ContentType_get operation.

ContentTypeGetOptionalParams

Optional parameters.

ContentTypeListByServiceNextOptionalParams

Optional parameters.

ContentTypeListByServiceOptionalParams

Optional parameters.

DataMasking
DataMaskingEntity
DelegationSettings

Interface representing a DelegationSettings.

DelegationSettingsCreateOrUpdateOptionalParams

Optional parameters.

DelegationSettingsGetEntityTagHeaders

Defines headers for DelegationSettings_getEntityTag operation.

DelegationSettingsGetEntityTagOptionalParams

Optional parameters.

DelegationSettingsGetHeaders

Defines headers for DelegationSettings_get operation.

DelegationSettingsGetOptionalParams

Optional parameters.

DelegationSettingsListSecretsOptionalParams

Optional parameters.

DelegationSettingsUpdateOptionalParams

Optional parameters.

DeletedServiceContract

Deleted API Management Service information.

DeletedServices

Interface representing a DeletedServices.

DeletedServicesCollection

Paged deleted API Management Services List Representation.

DeletedServicesGetByNameOptionalParams

Optional parameters.

DeletedServicesListBySubscriptionNextOptionalParams

Optional parameters.

DeletedServicesListBySubscriptionOptionalParams

Optional parameters.

DeletedServicesPurgeHeaders

Defines headers for DeletedServices_purge operation.

DeletedServicesPurgeOptionalParams

Optional parameters.

DeployConfigurationParameters

Deploy Tenant Configuration Contract.

Diagnostic

Interface representing a Diagnostic.

DiagnosticCollection

Paged Diagnostic list representation.

DiagnosticContract

Diagnostic details.

DiagnosticCreateOrUpdateHeaders

Defines headers for Diagnostic_createOrUpdate operation.

DiagnosticCreateOrUpdateOptionalParams

Optional parameters.

DiagnosticDeleteOptionalParams

Optional parameters.

DiagnosticGetEntityTagHeaders

Defines headers for Diagnostic_getEntityTag operation.

DiagnosticGetEntityTagOptionalParams

Optional parameters.

DiagnosticGetHeaders

Defines headers for Diagnostic_get operation.

DiagnosticGetOptionalParams

Optional parameters.

DiagnosticListByServiceNextOptionalParams

Optional parameters.

DiagnosticListByServiceOptionalParams

Optional parameters.

DiagnosticUpdateHeaders

Defines headers for Diagnostic_update operation.

DiagnosticUpdateOptionalParams

Optional parameters.

Documentation

Interface representing a Documentation.

DocumentationCollection

Paged Documentation list representation.

DocumentationContract

Markdown documentation details.

DocumentationCreateOrUpdateHeaders

Defines headers for Documentation_createOrUpdate operation.

DocumentationCreateOrUpdateOptionalParams

Optional parameters.

DocumentationDeleteOptionalParams

Optional parameters.

DocumentationGetEntityTagHeaders

Defines headers for Documentation_getEntityTag operation.

DocumentationGetEntityTagOptionalParams

Optional parameters.

DocumentationGetHeaders

Defines headers for Documentation_get operation.

DocumentationGetOptionalParams

Optional parameters.

DocumentationListByServiceNextOptionalParams

Optional parameters.

DocumentationListByServiceOptionalParams

Optional parameters.

DocumentationUpdateContract

Documentation update contract details.

DocumentationUpdateHeaders

Defines headers for Documentation_update operation.

DocumentationUpdateOptionalParams

Optional parameters.

EmailTemplate

Interface representing a EmailTemplate.

EmailTemplateCollection

Paged email template list representation.

EmailTemplateContract

Email Template details.

EmailTemplateCreateOrUpdateOptionalParams

Optional parameters.

EmailTemplateDeleteOptionalParams

Optional parameters.

EmailTemplateGetEntityTagHeaders

Defines headers for EmailTemplate_getEntityTag operation.

EmailTemplateGetEntityTagOptionalParams

Optional parameters.

EmailTemplateGetHeaders

Defines headers for EmailTemplate_get operation.

EmailTemplateGetOptionalParams

Optional parameters.

EmailTemplateListByServiceNextOptionalParams

Optional parameters.

EmailTemplateListByServiceOptionalParams

Optional parameters.

EmailTemplateParametersContractProperties

Email Template Parameter contract.

EmailTemplateUpdateHeaders

Defines headers for EmailTemplate_update operation.

EmailTemplateUpdateOptionalParams

Optional parameters.

EmailTemplateUpdateParameters

Email Template update Parameters.

EndpointDependency

A domain name that a service is reached at.

EndpointDetail

Current TCP connectivity information from the Api Management Service to a single endpoint.

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

ErrorResponseBody

Error Body contract.

Gateway

Interface representing a Gateway.

GatewayApi

Interface representing a GatewayApi.

GatewayApiCreateOrUpdateOptionalParams

Optional parameters.

GatewayApiDeleteOptionalParams

Optional parameters.

GatewayApiGetEntityTagHeaders

Defines headers for GatewayApi_getEntityTag operation.

GatewayApiGetEntityTagOptionalParams

Optional parameters.

GatewayApiListByServiceNextOptionalParams

Optional parameters.

GatewayApiListByServiceOptionalParams

Optional parameters.

GatewayCertificateAuthority

Interface representing a GatewayCertificateAuthority.

GatewayCertificateAuthorityCollection

Paged Gateway certificate authority list representation.

GatewayCertificateAuthorityContract

Gateway certificate authority details.

GatewayCertificateAuthorityCreateOrUpdateHeaders

Defines headers for GatewayCertificateAuthority_createOrUpdate operation.

GatewayCertificateAuthorityCreateOrUpdateOptionalParams

Optional parameters.

GatewayCertificateAuthorityDeleteOptionalParams

Optional parameters.

GatewayCertificateAuthorityGetEntityTagHeaders

Defines headers for GatewayCertificateAuthority_getEntityTag operation.

GatewayCertificateAuthorityGetEntityTagOptionalParams

Optional parameters.

GatewayCertificateAuthorityGetHeaders

Defines headers for GatewayCertificateAuthority_get operation.

GatewayCertificateAuthorityGetOptionalParams

Optional parameters.

GatewayCertificateAuthorityListByServiceNextOptionalParams

Optional parameters.

GatewayCertificateAuthorityListByServiceOptionalParams

Optional parameters.

GatewayCollection

Paged Gateway list representation.

GatewayContract

Gateway details.

GatewayCreateOrUpdateHeaders

Defines headers for Gateway_createOrUpdate operation.

GatewayCreateOrUpdateOptionalParams

Optional parameters.

GatewayDeleteOptionalParams

Optional parameters.

GatewayGenerateTokenOptionalParams

Optional parameters.

GatewayGetEntityTagHeaders

Defines headers for Gateway_getEntityTag operation.

GatewayGetEntityTagOptionalParams

Optional parameters.

GatewayGetHeaders

Defines headers for Gateway_get operation.

GatewayGetOptionalParams

Optional parameters.

GatewayHostnameConfiguration

Interface representing a GatewayHostnameConfiguration.

GatewayHostnameConfigurationCollection

Paged Gateway hostname configuration list representation.

GatewayHostnameConfigurationContract

Gateway hostname configuration details.

GatewayHostnameConfigurationCreateOrUpdateHeaders

Defines headers for GatewayHostnameConfiguration_createOrUpdate operation.

GatewayHostnameConfigurationCreateOrUpdateOptionalParams

Optional parameters.

GatewayHostnameConfigurationDeleteOptionalParams

Optional parameters.

GatewayHostnameConfigurationGetEntityTagHeaders

Defines headers for GatewayHostnameConfiguration_getEntityTag operation.

GatewayHostnameConfigurationGetEntityTagOptionalParams

Optional parameters.

GatewayHostnameConfigurationGetHeaders

Defines headers for GatewayHostnameConfiguration_get operation.

GatewayHostnameConfigurationGetOptionalParams

Optional parameters.

GatewayHostnameConfigurationListByServiceNextOptionalParams

Optional parameters.

GatewayHostnameConfigurationListByServiceOptionalParams

Optional parameters.

GatewayKeyRegenerationRequestContract

Gateway key regeneration request contract properties.

GatewayKeysContract

Gateway authentication keys.

GatewayListByServiceNextOptionalParams

Optional parameters.

GatewayListByServiceOptionalParams

Optional parameters.

GatewayListKeysHeaders

Defines headers for Gateway_listKeys operation.

GatewayListKeysOptionalParams

Optional parameters.

GatewayRegenerateKeyOptionalParams

Optional parameters.

GatewayTokenContract

Gateway access token.

GatewayTokenRequestContract

Gateway token request contract properties.

GatewayUpdateHeaders

Defines headers for Gateway_update operation.

GatewayUpdateOptionalParams

Optional parameters.

GenerateSsoUrlResult

Generate SSO Url operations response details.

GlobalSchema

Interface representing a GlobalSchema.

GlobalSchemaCollection

The response of the list schema operation.

GlobalSchemaContract

Global Schema Contract details.

GlobalSchemaCreateOrUpdateHeaders

Defines headers for GlobalSchema_createOrUpdate operation.

GlobalSchemaCreateOrUpdateOptionalParams

Optional parameters.

GlobalSchemaDeleteOptionalParams

Optional parameters.

GlobalSchemaGetEntityTagHeaders

Defines headers for GlobalSchema_getEntityTag operation.

GlobalSchemaGetEntityTagOptionalParams

Optional parameters.

GlobalSchemaGetHeaders

Defines headers for GlobalSchema_get operation.

GlobalSchemaGetOptionalParams

Optional parameters.

GlobalSchemaListByServiceNextOptionalParams

Optional parameters.

GlobalSchemaListByServiceOptionalParams

Optional parameters.

GraphQLApiResolver

Interface representing a GraphQLApiResolver.

GraphQLApiResolverCreateOrUpdateHeaders

Defines headers for GraphQLApiResolver_createOrUpdate operation.

GraphQLApiResolverCreateOrUpdateOptionalParams

Optional parameters.

GraphQLApiResolverDeleteOptionalParams

Optional parameters.

GraphQLApiResolverGetEntityTagHeaders

Defines headers for GraphQLApiResolver_getEntityTag operation.

GraphQLApiResolverGetEntityTagOptionalParams

Optional parameters.

GraphQLApiResolverGetHeaders

Defines headers for GraphQLApiResolver_get operation.

GraphQLApiResolverGetOptionalParams

Optional parameters.

GraphQLApiResolverListByApiNextOptionalParams

Optional parameters.

GraphQLApiResolverListByApiOptionalParams

Optional parameters.

GraphQLApiResolverPolicy

Interface representing a GraphQLApiResolverPolicy.

GraphQLApiResolverPolicyCreateOrUpdateHeaders

Defines headers for GraphQLApiResolverPolicy_createOrUpdate operation.

GraphQLApiResolverPolicyCreateOrUpdateOptionalParams

Optional parameters.

GraphQLApiResolverPolicyDeleteOptionalParams

Optional parameters.

GraphQLApiResolverPolicyGetEntityTagHeaders

Defines headers for GraphQLApiResolverPolicy_getEntityTag operation.

GraphQLApiResolverPolicyGetEntityTagOptionalParams

Optional parameters.

GraphQLApiResolverPolicyGetHeaders

Defines headers for GraphQLApiResolverPolicy_get operation.

GraphQLApiResolverPolicyGetOptionalParams

Optional parameters.

GraphQLApiResolverPolicyListByResolverNextOptionalParams

Optional parameters.

GraphQLApiResolverPolicyListByResolverOptionalParams

Optional parameters.

GraphQLApiResolverUpdateHeaders

Defines headers for GraphQLApiResolver_update operation.

GraphQLApiResolverUpdateOptionalParams

Optional parameters.

Group

Interface representing a Group.

GroupCollection

Paged Group list representation.

GroupContract

Contract details.

GroupContractProperties

Group contract Properties.

GroupCreateOrUpdateHeaders

Defines headers for Group_createOrUpdate operation.

GroupCreateOrUpdateOptionalParams

Optional parameters.

GroupCreateParameters

Parameters supplied to the Create Group operation.

GroupDeleteOptionalParams

Optional parameters.

GroupGetEntityTagHeaders

Defines headers for Group_getEntityTag operation.

GroupGetEntityTagOptionalParams

Optional parameters.

GroupGetHeaders

Defines headers for Group_get operation.

GroupGetOptionalParams

Optional parameters.

GroupListByServiceNextOptionalParams

Optional parameters.

GroupListByServiceOptionalParams

Optional parameters.

GroupUpdateHeaders

Defines headers for Group_update operation.

GroupUpdateOptionalParams

Optional parameters.

GroupUpdateParameters

Parameters supplied to the Update Group operation.

GroupUser

Interface representing a GroupUser.

GroupUserCheckEntityExistsOptionalParams

Optional parameters.

GroupUserCreateOptionalParams

Optional parameters.

GroupUserDeleteOptionalParams

Optional parameters.

GroupUserListNextOptionalParams

Optional parameters.

GroupUserListOptionalParams

Optional parameters.

HostnameConfiguration

Custom hostname configuration.

HttpHeader

HTTP header and it's value.

HttpMessageDiagnostic

Http message diagnostic settings.

IdentityProvider

Interface representing a IdentityProvider.

IdentityProviderBaseParameters

Identity Provider Base Parameter Properties.

IdentityProviderContract

Identity Provider details.

IdentityProviderContractProperties

The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.

IdentityProviderCreateContract

Identity Provider details.

IdentityProviderCreateContractProperties

The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.

IdentityProviderCreateOrUpdateHeaders

Defines headers for IdentityProvider_createOrUpdate operation.

IdentityProviderCreateOrUpdateOptionalParams

Optional parameters.

IdentityProviderDeleteOptionalParams

Optional parameters.

IdentityProviderGetEntityTagHeaders

Defines headers for IdentityProvider_getEntityTag operation.

IdentityProviderGetEntityTagOptionalParams

Optional parameters.

IdentityProviderGetHeaders

Defines headers for IdentityProvider_get operation.

IdentityProviderGetOptionalParams

Optional parameters.

IdentityProviderList

List of all the Identity Providers configured on the service instance.

IdentityProviderListByServiceNextOptionalParams

Optional parameters.

IdentityProviderListByServiceOptionalParams

Optional parameters.

IdentityProviderListSecretsHeaders

Defines headers for IdentityProvider_listSecrets operation.

IdentityProviderListSecretsOptionalParams

Optional parameters.

IdentityProviderUpdateHeaders

Defines headers for IdentityProvider_update operation.

IdentityProviderUpdateOptionalParams

Optional parameters.

IdentityProviderUpdateParameters

Parameters supplied to update Identity Provider

IdentityProviderUpdateProperties

Parameters supplied to the Update Identity Provider operation.

Issue

Interface representing a Issue.

IssueAttachmentCollection

Paged Issue Attachment list representation.

IssueAttachmentContract

Issue Attachment Contract details.

IssueCollection

Paged Issue list representation.

IssueCommentCollection

Paged Issue Comment list representation.

IssueCommentContract

Issue Comment Contract details.

IssueContract

Issue Contract details.

IssueContractBaseProperties

Issue contract Base Properties.

IssueContractProperties

Issue contract Properties.

IssueGetHeaders

Defines headers for Issue_get operation.

IssueGetOptionalParams

Optional parameters.

IssueListByServiceNextOptionalParams

Optional parameters.

IssueListByServiceOptionalParams

Optional parameters.

IssueUpdateContract

Issue update Parameters.

IssueUpdateContractProperties

Issue contract Update Properties.

KeyVaultContractCreateProperties

Create keyVault contract details.

KeyVaultContractProperties

KeyVault contract details.

KeyVaultLastAccessStatusContractProperties

Issue contract Update Properties.

Logger

Interface representing a Logger.

LoggerCollection

Paged Logger list representation.

LoggerContract

Logger details.

LoggerCreateOrUpdateHeaders

Defines headers for Logger_createOrUpdate operation.

LoggerCreateOrUpdateOptionalParams

Optional parameters.

LoggerDeleteOptionalParams

Optional parameters.

LoggerGetEntityTagHeaders

Defines headers for Logger_getEntityTag operation.

LoggerGetEntityTagOptionalParams

Optional parameters.

LoggerGetHeaders

Defines headers for Logger_get operation.

LoggerGetOptionalParams

Optional parameters.

LoggerListByServiceNextOptionalParams

Optional parameters.

LoggerListByServiceOptionalParams

Optional parameters.

LoggerUpdateContract

Logger update contract.

LoggerUpdateHeaders

Defines headers for Logger_update operation.

LoggerUpdateOptionalParams

Optional parameters.

NamedValue

Interface representing a NamedValue.

NamedValueCollection

Paged NamedValue list representation.

NamedValueContract

NamedValue details.

NamedValueContractProperties

NamedValue Contract properties.

NamedValueCreateContract

NamedValue details.

NamedValueCreateContractProperties

NamedValue Contract properties.

NamedValueCreateOrUpdateHeaders

Defines headers for NamedValue_createOrUpdate operation.

NamedValueCreateOrUpdateOptionalParams

Optional parameters.

NamedValueDeleteOptionalParams

Optional parameters.

NamedValueEntityBaseParameters

NamedValue Entity Base Parameters set.

NamedValueGetEntityTagHeaders

Defines headers for NamedValue_getEntityTag operation.

NamedValueGetEntityTagOptionalParams

Optional parameters.

NamedValueGetHeaders

Defines headers for NamedValue_get operation.

NamedValueGetOptionalParams

Optional parameters.

NamedValueListByServiceNextOptionalParams

Optional parameters.

NamedValueListByServiceOptionalParams

Optional parameters.

NamedValueListValueHeaders

Defines headers for NamedValue_listValue operation.

NamedValueListValueOptionalParams

Optional parameters.

NamedValueRefreshSecretHeaders

Defines headers for NamedValue_refreshSecret operation.

NamedValueRefreshSecretOptionalParams

Optional parameters.

NamedValueSecretContract

Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

NamedValueUpdateHeaders

Defines headers for NamedValue_update operation.

NamedValueUpdateOptionalParams

Optional parameters.

NamedValueUpdateParameterProperties

NamedValue Contract properties.

NamedValueUpdateParameters

NamedValue update Parameters.

NetworkStatus

Interface representing a NetworkStatus.

NetworkStatusContract

Network Status details.

NetworkStatusContractByLocation

Network Status in the Location

NetworkStatusListByLocationOptionalParams

Optional parameters.

NetworkStatusListByServiceOptionalParams

Optional parameters.

Notification

Interface representing a Notification.

NotificationCollection

Paged Notification list representation.

NotificationContract

Notification details.

NotificationCreateOrUpdateOptionalParams

Optional parameters.

NotificationGetOptionalParams

Optional parameters.

NotificationListByServiceNextOptionalParams

Optional parameters.

NotificationListByServiceOptionalParams

Optional parameters.

NotificationRecipientEmail

Interface representing a NotificationRecipientEmail.

NotificationRecipientEmailCheckEntityExistsOptionalParams

Optional parameters.

NotificationRecipientEmailCreateOrUpdateOptionalParams

Optional parameters.

NotificationRecipientEmailDeleteOptionalParams

Optional parameters.

NotificationRecipientEmailListByNotificationOptionalParams

Optional parameters.

NotificationRecipientUser

Interface representing a NotificationRecipientUser.

NotificationRecipientUserCheckEntityExistsOptionalParams

Optional parameters.

NotificationRecipientUserCreateOrUpdateOptionalParams

Optional parameters.

NotificationRecipientUserDeleteOptionalParams

Optional parameters.

NotificationRecipientUserListByNotificationOptionalParams

Optional parameters.

OAuth2AuthenticationSettingsContract

API OAuth2 Authentication settings details.

OpenIdAuthenticationSettingsContract

API OAuth2 Authentication settings details.

OpenIdConnectProvider

Interface representing a OpenIdConnectProvider.

OpenIdConnectProviderCollection

Paged OpenIdProviders list representation.

OpenIdConnectProviderCreateOrUpdateHeaders

Defines headers for OpenIdConnectProvider_createOrUpdate operation.

OpenIdConnectProviderCreateOrUpdateOptionalParams

Optional parameters.

OpenIdConnectProviderDeleteOptionalParams

Optional parameters.

OpenIdConnectProviderGetEntityTagHeaders

Defines headers for OpenIdConnectProvider_getEntityTag operation.

OpenIdConnectProviderGetEntityTagOptionalParams

Optional parameters.

OpenIdConnectProviderGetHeaders

Defines headers for OpenIdConnectProvider_get operation.

OpenIdConnectProviderGetOptionalParams

Optional parameters.

OpenIdConnectProviderListByServiceNextOptionalParams

Optional parameters.

OpenIdConnectProviderListByServiceOptionalParams

Optional parameters.

OpenIdConnectProviderListSecretsHeaders

Defines headers for OpenIdConnectProvider_listSecrets operation.

OpenIdConnectProviderListSecretsOptionalParams

Optional parameters.

OpenIdConnectProviderUpdateHeaders

Defines headers for OpenIdConnectProvider_update operation.

OpenIdConnectProviderUpdateOptionalParams

Optional parameters.

OpenidConnectProviderContract

OpenId Connect Provider details.

OpenidConnectProviderUpdateContract

Parameters supplied to the Update OpenID Connect Provider operation.

Operation

REST API operation

OperationCollection

Paged Operation list representation.

OperationContract

API Operation details.

OperationContractProperties

Operation Contract Properties

OperationDisplay

The object that describes the operation.

OperationEntityBaseContract

API Operation Entity Base Contract details.

OperationListByTagsNextOptionalParams

Optional parameters.

OperationListByTagsOptionalParams

Optional parameters.

OperationListResult

Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.

OperationOperations

Interface representing a OperationOperations.

OperationResultContract

Long Running Git Operation Results.

OperationResultLogItemContract

Log of the entity being created, updated or deleted.

OperationTagResourceContractProperties

Operation Entity contract Properties.

OperationUpdateContract

API Operation Update Contract details.

OperationUpdateContractProperties

Operation Update Contract Properties.

OutboundEnvironmentEndpoint

Endpoints accessed for a common purpose that the Api Management Service requires outbound network access to.

OutboundEnvironmentEndpointList

Collection of Outbound Environment Endpoints

OutboundNetworkDependenciesEndpoints

Interface representing a OutboundNetworkDependenciesEndpoints.

OutboundNetworkDependenciesEndpointsListByServiceOptionalParams

Optional parameters.

ParameterContract

Operation parameters details.

ParameterExampleContract

Parameter example.

PerformConnectivityCheckAsyncOptionalParams

Optional parameters.

PipelineDiagnosticSettings

Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.

Policy

Interface representing a Policy.

PolicyCollection

The response of the list policy operation.

PolicyContract

Policy Contract details.

PolicyCreateOrUpdateHeaders

Defines headers for Policy_createOrUpdate operation.

PolicyCreateOrUpdateOptionalParams

Optional parameters.

PolicyDeleteOptionalParams

Optional parameters.

PolicyDescription

Interface representing a PolicyDescription.

PolicyDescriptionCollection

Descriptions of API Management policies.

PolicyDescriptionContract

Policy description details.

PolicyDescriptionListByServiceOptionalParams

Optional parameters.

PolicyFragment

Interface representing a PolicyFragment.

PolicyFragmentCollection

The response of the get policy fragments operation.

PolicyFragmentContract

Policy fragment contract details.

PolicyFragmentCreateOrUpdateHeaders

Defines headers for PolicyFragment_createOrUpdate operation.

PolicyFragmentCreateOrUpdateOptionalParams

Optional parameters.

PolicyFragmentDeleteOptionalParams

Optional parameters.

PolicyFragmentGetEntityTagHeaders

Defines headers for PolicyFragment_getEntityTag operation.

PolicyFragmentGetEntityTagOptionalParams

Optional parameters.

PolicyFragmentGetHeaders

Defines headers for PolicyFragment_get operation.

PolicyFragmentGetOptionalParams

Optional parameters.

PolicyFragmentListByServiceOptionalParams

Optional parameters.

PolicyFragmentListReferencesOptionalParams

Optional parameters.

PolicyGetEntityTagHeaders

Defines headers for Policy_getEntityTag operation.

PolicyGetEntityTagOptionalParams

Optional parameters.

PolicyGetHeaders

Defines headers for Policy_get operation.

PolicyGetOptionalParams

Optional parameters.

PolicyListByServiceOptionalParams

Optional parameters.

PortalConfig

Interface representing a PortalConfig.

PortalConfigCollection

The collection of the developer portal configurations.

PortalConfigContract

The developer portal configuration contract.

PortalConfigCorsProperties

The developer portal Cross-Origin Resource Sharing (CORS) settings.

PortalConfigCreateOrUpdateOptionalParams

Optional parameters.

PortalConfigCspProperties

The developer portal Content Security Policy (CSP) settings.

PortalConfigDelegationProperties
PortalConfigGetEntityTagHeaders

Defines headers for PortalConfig_getEntityTag operation.

PortalConfigGetEntityTagOptionalParams

Optional parameters.

PortalConfigGetHeaders

Defines headers for PortalConfig_get operation.

PortalConfigGetOptionalParams

Optional parameters.

PortalConfigListByServiceOptionalParams

Optional parameters.

PortalConfigPropertiesSignin
PortalConfigPropertiesSignup
PortalConfigTermsOfServiceProperties

Terms of service contract properties.

PortalConfigUpdateOptionalParams

Optional parameters.

PortalDelegationSettings

Delegation settings for a developer portal.

PortalRevision

Interface representing a PortalRevision.

PortalRevisionCollection

Paged list of portal revisions.

PortalRevisionContract

Portal Revision's contract details.

PortalRevisionCreateOrUpdateHeaders

Defines headers for PortalRevision_createOrUpdate operation.

PortalRevisionCreateOrUpdateOptionalParams

Optional parameters.

PortalRevisionGetEntityTagHeaders

Defines headers for PortalRevision_getEntityTag operation.

PortalRevisionGetEntityTagOptionalParams

Optional parameters.

PortalRevisionGetHeaders

Defines headers for PortalRevision_get operation.

PortalRevisionGetOptionalParams

Optional parameters.

PortalRevisionListByServiceNextOptionalParams

Optional parameters.

PortalRevisionListByServiceOptionalParams

Optional parameters.

PortalRevisionUpdateHeaders

Defines headers for PortalRevision_update operation.

PortalRevisionUpdateOptionalParams

Optional parameters.

PortalSettingValidationKeyContract

Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

PortalSettings

Interface representing a PortalSettings.

PortalSettingsCollection

Descriptions of API Management policies.

PortalSettingsContract

Portal Settings for the Developer Portal.

PortalSettingsListByServiceOptionalParams

Optional parameters.

PortalSigninSettings

Sign-In settings for the Developer Portal.

PortalSignupSettings

Sign-Up settings for a developer portal.

PrivateEndpoint

The Private Endpoint resource.

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionCreateOrUpdateOptionalParams

Optional parameters.

PrivateEndpointConnectionDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionGetByNameOptionalParams

Optional parameters.

PrivateEndpointConnectionGetPrivateLinkResourceOptionalParams

Optional parameters.

PrivateEndpointConnectionListByServiceOptionalParams

Optional parameters.

PrivateEndpointConnectionListPrivateLinkResourcesOptionalParams

Optional parameters.

PrivateEndpointConnectionListResult

List of private endpoint connection associated with the specified storage account

PrivateEndpointConnectionOperations

Interface representing a PrivateEndpointConnectionOperations.

PrivateEndpointConnectionRequest

A request to approve or reject a private endpoint connection

PrivateEndpointConnectionRequestProperties

The connection state of the private endpoint connection.

PrivateLinkResource

A private link resource

PrivateLinkResourceListResult

A list of private link resources

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

Product

Interface representing a Product.

ProductApi

Interface representing a ProductApi.

ProductApiCheckEntityExistsOptionalParams

Optional parameters.

ProductApiCreateOrUpdateOptionalParams

Optional parameters.

ProductApiDeleteOptionalParams

Optional parameters.

ProductApiListByProductNextOptionalParams

Optional parameters.

ProductApiListByProductOptionalParams

Optional parameters.

ProductCollection

Paged Products list representation.

ProductContract

Product details.

ProductContractProperties

Product profile.

ProductCreateOrUpdateHeaders

Defines headers for Product_createOrUpdate operation.

ProductCreateOrUpdateOptionalParams

Optional parameters.

ProductDeleteOptionalParams

Optional parameters.

ProductEntityBaseParameters

Product Entity Base Parameters

ProductGetEntityTagHeaders

Defines headers for Product_getEntityTag operation.

ProductGetEntityTagOptionalParams

Optional parameters.

ProductGetHeaders

Defines headers for Product_get operation.

ProductGetOptionalParams

Optional parameters.

ProductGroup

Interface representing a ProductGroup.

ProductGroupCheckEntityExistsOptionalParams

Optional parameters.

ProductGroupCreateOrUpdateOptionalParams

Optional parameters.

ProductGroupDeleteOptionalParams

Optional parameters.

ProductGroupListByProductNextOptionalParams

Optional parameters.

ProductGroupListByProductOptionalParams

Optional parameters.

ProductListByServiceNextOptionalParams

Optional parameters.

ProductListByServiceOptionalParams

Optional parameters.

ProductListByTagsNextOptionalParams

Optional parameters.

ProductListByTagsOptionalParams

Optional parameters.

ProductPolicy

Interface representing a ProductPolicy.

ProductPolicyCreateOrUpdateHeaders

Defines headers for ProductPolicy_createOrUpdate operation.

ProductPolicyCreateOrUpdateOptionalParams

Optional parameters.

ProductPolicyDeleteOptionalParams

Optional parameters.

ProductPolicyGetEntityTagHeaders

Defines headers for ProductPolicy_getEntityTag operation.

ProductPolicyGetEntityTagOptionalParams

Optional parameters.

ProductPolicyGetHeaders

Defines headers for ProductPolicy_get operation.

ProductPolicyGetOptionalParams

Optional parameters.

ProductPolicyListByProductOptionalParams

Optional parameters.

ProductSubscriptions

Interface representing a ProductSubscriptions.

ProductSubscriptionsListNextOptionalParams

Optional parameters.

ProductSubscriptionsListOptionalParams

Optional parameters.

ProductTagResourceContractProperties

Product profile.

ProductUpdateHeaders

Defines headers for Product_update operation.

ProductUpdateOptionalParams

Optional parameters.

ProductUpdateParameters

Product Update parameters.

ProductUpdateProperties

Parameters supplied to the Update Product operation.

ProductWiki

Interface representing a ProductWiki.

ProductWikiCreateOrUpdateHeaders

Defines headers for ProductWiki_createOrUpdate operation.

ProductWikiCreateOrUpdateOptionalParams

Optional parameters.

ProductWikiDeleteOptionalParams

Optional parameters.

ProductWikiGetEntityTagHeaders

Defines headers for ProductWiki_getEntityTag operation.

ProductWikiGetEntityTagOptionalParams

Optional parameters.

ProductWikiGetHeaders

Defines headers for ProductWiki_get operation.

ProductWikiGetOptionalParams

Optional parameters.

ProductWikiUpdateHeaders

Defines headers for ProductWiki_update operation.

ProductWikiUpdateOptionalParams

Optional parameters.

ProductWikis

Interface representing a ProductWikis.

ProductWikisListHeaders

Defines headers for ProductWikis_list operation.

ProductWikisListNextHeaders

Defines headers for ProductWikis_listNext operation.

ProductWikisListNextOptionalParams

Optional parameters.

ProductWikisListOptionalParams

Optional parameters.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

QuotaByCounterKeys

Interface representing a QuotaByCounterKeys.

QuotaByCounterKeysListByServiceOptionalParams

Optional parameters.

QuotaByCounterKeysUpdateOptionalParams

Optional parameters.

QuotaByPeriodKeys

Interface representing a QuotaByPeriodKeys.

QuotaByPeriodKeysGetOptionalParams

Optional parameters.

QuotaByPeriodKeysUpdateOptionalParams

Optional parameters.

QuotaCounterCollection

Paged Quota Counter list representation.

QuotaCounterContract

Quota counter details.

QuotaCounterValueContract

Quota counter value details.

QuotaCounterValueContractProperties

Quota counter value details.

QuotaCounterValueUpdateContract

Quota counter value details.

RecipientEmailCollection

Paged Recipient User list representation.

RecipientEmailContract

Recipient Email details.

RecipientUserCollection

Paged Recipient User list representation.

RecipientUserContract

Recipient User details.

RecipientsContractProperties

Notification Parameter contract.

Region

Interface representing a Region.

RegionContract

Region profile.

RegionListByServiceNextOptionalParams

Optional parameters.

RegionListByServiceOptionalParams

Optional parameters.

RegionListResult

Lists Regions operation response details.

RegistrationDelegationSettingsProperties

User registration delegation settings properties.

RemotePrivateEndpointConnectionWrapper

Remote Private Endpoint Connection resource.

ReportCollection

Paged Report records list representation.

ReportRecordContract

Report data.

Reports

Interface representing a Reports.

ReportsListByApiNextOptionalParams

Optional parameters.

ReportsListByApiOptionalParams

Optional parameters.

ReportsListByGeoNextOptionalParams

Optional parameters.

ReportsListByGeoOptionalParams

Optional parameters.

ReportsListByOperationNextOptionalParams

Optional parameters.

ReportsListByOperationOptionalParams

Optional parameters.

ReportsListByProductNextOptionalParams

Optional parameters.

ReportsListByProductOptionalParams

Optional parameters.

ReportsListByRequestOptionalParams

Optional parameters.

ReportsListBySubscriptionNextOptionalParams

Optional parameters.

ReportsListBySubscriptionOptionalParams

Optional parameters.

ReportsListByTimeNextOptionalParams

Optional parameters.

ReportsListByTimeOptionalParams

Optional parameters.

ReportsListByUserNextOptionalParams

Optional parameters.

ReportsListByUserOptionalParams

Optional parameters.

RepresentationContract

Operation request/response representation details.

RequestContract

Operation request details.

RequestReportCollection

Paged Report records list representation.

RequestReportRecordContract

Request Report data.

ResolverCollection

Paged Resolver list representation.

ResolverContract

GraphQL API Resolver details.

ResolverResultContract

Long Running Git Resolver Results.

ResolverResultLogItemContract

Log of the entity being created, updated or deleted.

ResolverUpdateContract

GraphQL API Resolver Update Contract details.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

ResourceCollection

A collection of resources.

ResourceCollectionValueItem

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

ResourceLocationDataContract

Resource location data properties.

ResourceSku

Describes an available API Management SKU.

ResourceSkuCapacity

Describes scaling information of a SKU.

ResourceSkuResult

Describes an available API Management service SKU.

ResourceSkuResults

The API Management service SKUs operation response.

ResponseContract

Operation response details.

SamplingSettings

Sampling settings for Diagnostic.

SaveConfigurationParameter

Save Tenant Configuration Contract details.

SchemaCollection

The response of the list schema operation.

SchemaContract

API Schema Contract details.

SignInSettings

Interface representing a SignInSettings.

SignInSettingsCreateOrUpdateOptionalParams

Optional parameters.

SignInSettingsGetEntityTagHeaders

Defines headers for SignInSettings_getEntityTag operation.

SignInSettingsGetEntityTagOptionalParams

Optional parameters.

SignInSettingsGetHeaders

Defines headers for SignInSettings_get operation.

SignInSettingsGetOptionalParams

Optional parameters.

SignInSettingsUpdateOptionalParams

Optional parameters.

SignUpSettings

Interface representing a SignUpSettings.

SignUpSettingsCreateOrUpdateOptionalParams

Optional parameters.

SignUpSettingsGetEntityTagHeaders

Defines headers for SignUpSettings_getEntityTag operation.

SignUpSettingsGetEntityTagOptionalParams

Optional parameters.

SignUpSettingsGetHeaders

Defines headers for SignUpSettings_get operation.

SignUpSettingsGetOptionalParams

Optional parameters.

SignUpSettingsUpdateOptionalParams

Optional parameters.

Subscription

Interface representing a Subscription.

SubscriptionCollection

Paged Subscriptions list representation.

SubscriptionContract

Subscription details.

SubscriptionCreateOrUpdateHeaders

Defines headers for Subscription_createOrUpdate operation.

SubscriptionCreateOrUpdateOptionalParams

Optional parameters.

SubscriptionCreateParameters

Subscription create details.

SubscriptionDeleteOptionalParams

Optional parameters.

SubscriptionGetEntityTagHeaders

Defines headers for Subscription_getEntityTag operation.

SubscriptionGetEntityTagOptionalParams

Optional parameters.

SubscriptionGetHeaders

Defines headers for Subscription_get operation.

SubscriptionGetOptionalParams

Optional parameters.

SubscriptionKeyParameterNamesContract

Subscription key parameter names details.

SubscriptionKeysContract

Subscription keys.

SubscriptionListNextOptionalParams

Optional parameters.

SubscriptionListOptionalParams

Optional parameters.

SubscriptionListSecretsHeaders

Defines headers for Subscription_listSecrets operation.

SubscriptionListSecretsOptionalParams

Optional parameters.

SubscriptionRegeneratePrimaryKeyOptionalParams

Optional parameters.

SubscriptionRegenerateSecondaryKeyOptionalParams

Optional parameters.

SubscriptionUpdateHeaders

Defines headers for Subscription_update operation.

SubscriptionUpdateOptionalParams

Optional parameters.

SubscriptionUpdateParameters

Subscription update details.

SubscriptionsDelegationSettingsProperties

Subscriptions delegation settings properties.

SystemData

Metadata pertaining to creation and last modification of the resource.

Tag

Interface representing a Tag.

TagAssignToApiHeaders

Defines headers for Tag_assignToApi operation.

TagAssignToApiOptionalParams

Optional parameters.

TagAssignToOperationOptionalParams

Optional parameters.

TagAssignToProductOptionalParams

Optional parameters.

TagCollection

Paged Tag list representation.

TagContract

Tag Contract details.

TagCreateOrUpdateHeaders

Defines headers for Tag_createOrUpdate operation.

TagCreateOrUpdateOptionalParams

Optional parameters.

TagCreateUpdateParameters

Parameters supplied to Create/Update Tag operations.

TagDeleteOptionalParams

Optional parameters.

TagDescriptionBaseProperties

Parameters supplied to the Create TagDescription operation.

TagDescriptionCollection

Paged TagDescription list representation.

TagDescriptionContract

Contract details.

TagDescriptionContractProperties

TagDescription contract Properties.

TagDescriptionCreateParameters

Parameters supplied to the Create TagDescription operation.

TagDetachFromApiOptionalParams

Optional parameters.

TagDetachFromOperationOptionalParams

Optional parameters.

TagDetachFromProductOptionalParams

Optional parameters.

TagGetByApiHeaders

Defines headers for Tag_getByApi operation.

TagGetByApiOptionalParams

Optional parameters.

TagGetByOperationHeaders

Defines headers for Tag_getByOperation operation.

TagGetByOperationOptionalParams

Optional parameters.

TagGetByProductHeaders

Defines headers for Tag_getByProduct operation.

TagGetByProductOptionalParams

Optional parameters.

TagGetEntityStateByApiHeaders

Defines headers for Tag_getEntityStateByApi operation.

TagGetEntityStateByApiOptionalParams

Optional parameters.

TagGetEntityStateByOperationHeaders

Defines headers for Tag_getEntityStateByOperation operation.

TagGetEntityStateByOperationOptionalParams

Optional parameters.

TagGetEntityStateByProductHeaders

Defines headers for Tag_getEntityStateByProduct operation.

TagGetEntityStateByProductOptionalParams

Optional parameters.

TagGetEntityStateHeaders

Defines headers for Tag_getEntityState operation.

TagGetEntityStateOptionalParams

Optional parameters.

TagGetHeaders

Defines headers for Tag_get operation.

TagGetOptionalParams

Optional parameters.

TagListByApiNextOptionalParams

Optional parameters.

TagListByApiOptionalParams

Optional parameters.

TagListByOperationNextOptionalParams

Optional parameters.

TagListByOperationOptionalParams

Optional parameters.

TagListByProductNextOptionalParams

Optional parameters.

TagListByProductOptionalParams

Optional parameters.

TagListByServiceNextOptionalParams

Optional parameters.

TagListByServiceOptionalParams

Optional parameters.

TagResource

Interface representing a TagResource.

TagResourceCollection

Paged Tag list representation.

TagResourceContract

TagResource contract properties.

TagResourceContractProperties

Contract defining the Tag property in the Tag Resource Contract

TagResourceListByServiceNextOptionalParams

Optional parameters.

TagResourceListByServiceOptionalParams

Optional parameters.

TagUpdateHeaders

Defines headers for Tag_update operation.

TagUpdateOptionalParams

Optional parameters.

TenantAccess

Interface representing a TenantAccess.

TenantAccessCreateHeaders

Defines headers for TenantAccess_create operation.

TenantAccessCreateOptionalParams

Optional parameters.

TenantAccessGetEntityTagHeaders

Defines headers for TenantAccess_getEntityTag operation.

TenantAccessGetEntityTagOptionalParams

Optional parameters.

TenantAccessGetHeaders

Defines headers for TenantAccess_get operation.

TenantAccessGetOptionalParams

Optional parameters.

TenantAccessGit

Interface representing a TenantAccessGit.

TenantAccessGitRegeneratePrimaryKeyOptionalParams

Optional parameters.

TenantAccessGitRegenerateSecondaryKeyOptionalParams

Optional parameters.

TenantAccessListByServiceNextOptionalParams

Optional parameters.

TenantAccessListByServiceOptionalParams

Optional parameters.

TenantAccessListSecretsHeaders

Defines headers for TenantAccess_listSecrets operation.

TenantAccessListSecretsOptionalParams

Optional parameters.

TenantAccessRegeneratePrimaryKeyOptionalParams

Optional parameters.

TenantAccessRegenerateSecondaryKeyOptionalParams

Optional parameters.

TenantAccessUpdateHeaders

Defines headers for TenantAccess_update operation.

TenantAccessUpdateOptionalParams

Optional parameters.

TenantConfiguration

Interface representing a TenantConfiguration.

TenantConfigurationDeployOptionalParams

Optional parameters.

TenantConfigurationGetSyncStateOptionalParams

Optional parameters.

TenantConfigurationSaveOptionalParams

Optional parameters.

TenantConfigurationSyncStateContract

Result of Tenant Configuration Sync State.

TenantConfigurationValidateOptionalParams

Optional parameters.

TenantSettings

Interface representing a TenantSettings.

TenantSettingsCollection

Paged AccessInformation list representation.

TenantSettingsContract

Tenant Settings.

TenantSettingsGetHeaders

Defines headers for TenantSettings_get operation.

TenantSettingsGetOptionalParams

Optional parameters.

TenantSettingsListByServiceNextOptionalParams

Optional parameters.

TenantSettingsListByServiceOptionalParams

Optional parameters.

TermsOfServiceProperties

Terms of service contract properties.

TokenBodyParameterContract

OAuth acquire token request body parameter (www-url-form-encoded).

User

Interface representing a User.

UserCollection

Paged Users list representation.

UserConfirmationPassword

Interface representing a UserConfirmationPassword.

UserConfirmationPasswordSendOptionalParams

Optional parameters.

UserContract

User details.

UserContractProperties

User profile.

UserCreateOrUpdateHeaders

Defines headers for User_createOrUpdate operation.

UserCreateOrUpdateOptionalParams

Optional parameters.

UserCreateParameterProperties

Parameters supplied to the Create User operation.

UserCreateParameters

User create details.

UserDeleteOptionalParams

Optional parameters.

UserEntityBaseParameters

User Entity Base Parameters set.

UserGenerateSsoUrlOptionalParams

Optional parameters.

UserGetEntityTagHeaders

Defines headers for User_getEntityTag operation.

UserGetEntityTagOptionalParams

Optional parameters.

UserGetHeaders

Defines headers for User_get operation.

UserGetOptionalParams

Optional parameters.

UserGetSharedAccessTokenOptionalParams

Optional parameters.

UserGroup

Interface representing a UserGroup.

UserGroupListNextOptionalParams

Optional parameters.

UserGroupListOptionalParams

Optional parameters.

UserIdentities

Interface representing a UserIdentities.

UserIdentitiesListNextOptionalParams

Optional parameters.

UserIdentitiesListOptionalParams

Optional parameters.

UserIdentityCollection

List of Users Identity list representation.

UserIdentityContract

User identity details.

UserIdentityProperties
UserListByServiceNextOptionalParams

Optional parameters.

UserListByServiceOptionalParams

Optional parameters.

UserSubscription

Interface representing a UserSubscription.

UserSubscriptionGetHeaders

Defines headers for UserSubscription_get operation.

UserSubscriptionGetOptionalParams

Optional parameters.

UserSubscriptionListNextOptionalParams

Optional parameters.

UserSubscriptionListOptionalParams

Optional parameters.

UserTokenParameters

Get User Token parameters.

UserTokenResult

Get User Token response details.

UserUpdateHeaders

Defines headers for User_update operation.

UserUpdateOptionalParams

Optional parameters.

UserUpdateParameters

User update parameters.

UserUpdateParametersProperties

Parameters supplied to the Update User operation.

VirtualNetworkConfiguration

Configuration of a virtual network to which API Management service is deployed.

WikiCollection

Paged Wiki list representation.

WikiContract

Wiki properties

WikiDocumentationContract

Wiki documentation details.

WikiUpdateContract

Wiki update contract details.

X509CertificateName

Properties of server X509Names.

Type Aliases

AccessIdName

Defines values for AccessIdName.
KnownAccessIdName can be used interchangeably with AccessIdName, this enum contains the known values that the service supports.

Known values supported by the service

access
gitAccess

AccessType

Defines values for AccessType.
KnownAccessType can be used interchangeably with AccessType, this enum contains the known values that the service supports.

Known values supported by the service

AccessKey: Use access key.
SystemAssignedManagedIdentity: Use system assigned managed identity.
UserAssignedManagedIdentity: Use user assigned managed identity.

AlwaysLog

Defines values for AlwaysLog.
KnownAlwaysLog can be used interchangeably with AlwaysLog, this enum contains the known values that the service supports.

Known values supported by the service

allErrors: Always log all erroneous request regardless of sampling settings.

ApiCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ApiDiagnosticCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ApiDiagnosticGetEntityTagResponse

Contains response data for the getEntityTag operation.

ApiDiagnosticGetResponse

Contains response data for the get operation.

ApiDiagnosticListByServiceNextResponse

Contains response data for the listByServiceNext operation.

ApiDiagnosticListByServiceResponse

Contains response data for the listByService operation.

ApiDiagnosticUpdateResponse

Contains response data for the update operation.

ApiExportGetResponse

Contains response data for the get operation.

ApiGetEntityTagResponse

Contains response data for the getEntityTag operation.

ApiGetResponse

Contains response data for the get operation.

ApiIssueAttachmentCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ApiIssueAttachmentGetEntityTagResponse

Contains response data for the getEntityTag operation.

ApiIssueAttachmentGetResponse

Contains response data for the get operation.

ApiIssueAttachmentListByServiceNextResponse

Contains response data for the listByServiceNext operation.

ApiIssueAttachmentListByServiceResponse

Contains response data for the listByService operation.

ApiIssueCommentCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ApiIssueCommentGetEntityTagResponse

Contains response data for the getEntityTag operation.

ApiIssueCommentGetResponse

Contains response data for the get operation.

ApiIssueCommentListByServiceNextResponse

Contains response data for the listByServiceNext operation.

ApiIssueCommentListByServiceResponse

Contains response data for the listByService operation.

ApiIssueCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ApiIssueGetEntityTagResponse

Contains response data for the getEntityTag operation.

ApiIssueGetResponse

Contains response data for the get operation.

ApiIssueListByServiceNextResponse

Contains response data for the listByServiceNext operation.

ApiIssueListByServiceResponse

Contains response data for the listByService operation.

ApiIssueUpdateResponse

Contains response data for the update operation.

ApiListByServiceNextResponse

Contains response data for the listByServiceNext operation.

ApiListByServiceResponse

Contains response data for the listByService operation.

ApiListByTagsNextResponse

Contains response data for the listByTagsNext operation.

ApiListByTagsResponse

Contains response data for the listByTags operation.

ApiManagementOperationsListNextResponse

Contains response data for the listNext operation.

ApiManagementOperationsListResponse

Contains response data for the list operation.

ApiManagementServiceApplyNetworkConfigurationUpdatesResponse

Contains response data for the applyNetworkConfigurationUpdates operation.

ApiManagementServiceBackupResponse

Contains response data for the backup operation.

ApiManagementServiceCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

ApiManagementServiceCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ApiManagementServiceGetDomainOwnershipIdentifierResponse

Contains response data for the getDomainOwnershipIdentifier operation.

ApiManagementServiceGetResponse

Contains response data for the get operation.

ApiManagementServiceGetSsoTokenResponse

Contains response data for the getSsoToken operation.

ApiManagementServiceListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

ApiManagementServiceListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

ApiManagementServiceListNextResponse

Contains response data for the listNext operation.

ApiManagementServiceListResponse

Contains response data for the list operation.

ApiManagementServiceMigrateToStv2Response

Contains response data for the migrateToStv2 operation.

ApiManagementServiceRestoreResponse

Contains response data for the restore operation.

ApiManagementServiceSkusListAvailableServiceSkusNextResponse

Contains response data for the listAvailableServiceSkusNext operation.

ApiManagementServiceSkusListAvailableServiceSkusResponse

Contains response data for the listAvailableServiceSkus operation.

ApiManagementServiceUpdateResponse

Contains response data for the update operation.

ApiManagementSkuCapacityScaleType

Defines values for ApiManagementSkuCapacityScaleType.

ApiManagementSkuRestrictionsReasonCode

Defines values for ApiManagementSkuRestrictionsReasonCode.

ApiManagementSkuRestrictionsType

Defines values for ApiManagementSkuRestrictionsType.

ApiManagementSkusListNextResponse

Contains response data for the listNext operation.

ApiManagementSkusListResponse

Contains response data for the list operation.

ApiOperationCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ApiOperationGetEntityTagResponse

Contains response data for the getEntityTag operation.

ApiOperationGetResponse

Contains response data for the get operation.

ApiOperationListByApiNextResponse

Contains response data for the listByApiNext operation.

ApiOperationListByApiResponse

Contains response data for the listByApi operation.

ApiOperationPolicyCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ApiOperationPolicyGetEntityTagResponse

Contains response data for the getEntityTag operation.

ApiOperationPolicyGetResponse

Contains response data for the get operation.

ApiOperationPolicyListByOperationResponse

Contains response data for the listByOperation operation.

ApiOperationUpdateResponse

Contains response data for the update operation.

ApiPolicyCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ApiPolicyGetEntityTagResponse

Contains response data for the getEntityTag operation.

ApiPolicyGetResponse

Contains response data for the get operation.

ApiPolicyListByApiResponse

Contains response data for the listByApi operation.

ApiProductListByApisNextResponse

Contains response data for the listByApisNext operation.

ApiProductListByApisResponse

Contains response data for the listByApis operation.

ApiReleaseCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ApiReleaseGetEntityTagResponse

Contains response data for the getEntityTag operation.

ApiReleaseGetResponse

Contains response data for the get operation.

ApiReleaseListByServiceNextResponse

Contains response data for the listByServiceNext operation.

ApiReleaseListByServiceResponse

Contains response data for the listByService operation.

ApiReleaseUpdateResponse

Contains response data for the update operation.

ApiRevisionListByServiceNextResponse

Contains response data for the listByServiceNext operation.

ApiRevisionListByServiceResponse

Contains response data for the listByService operation.

ApiSchemaCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ApiSchemaGetEntityTagResponse

Contains response data for the getEntityTag operation.

ApiSchemaGetResponse

Contains response data for the get operation.

ApiSchemaListByApiNextResponse

Contains response data for the listByApiNext operation.

ApiSchemaListByApiResponse

Contains response data for the listByApi operation.

ApiTagDescriptionCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ApiTagDescriptionGetEntityTagResponse

Contains response data for the getEntityTag operation.

ApiTagDescriptionGetResponse

Contains response data for the get operation.

ApiTagDescriptionListByServiceNextResponse

Contains response data for the listByServiceNext operation.

ApiTagDescriptionListByServiceResponse

Contains response data for the listByService operation.

ApiType

Defines values for ApiType.
KnownApiType can be used interchangeably with ApiType, this enum contains the known values that the service supports.

Known values supported by the service

http
soap
websocket
graphql

ApiUpdateResponse

Contains response data for the update operation.

ApiVersionSetContractDetailsVersioningScheme

Defines values for ApiVersionSetContractDetailsVersioningScheme.
KnownApiVersionSetContractDetailsVersioningScheme can be used interchangeably with ApiVersionSetContractDetailsVersioningScheme, this enum contains the known values that the service supports.

Known values supported by the service

Segment: The API Version is passed in a path segment.
Query: The API Version is passed in a query parameter.
Header: The API Version is passed in a HTTP header.

ApiVersionSetCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ApiVersionSetGetEntityTagResponse

Contains response data for the getEntityTag operation.

ApiVersionSetGetResponse

Contains response data for the get operation.

ApiVersionSetListByServiceNextResponse

Contains response data for the listByServiceNext operation.

ApiVersionSetListByServiceResponse

Contains response data for the listByService operation.

ApiVersionSetUpdateResponse

Contains response data for the update operation.

ApiWikiCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ApiWikiGetEntityTagResponse

Contains response data for the getEntityTag operation.

ApiWikiGetResponse

Contains response data for the get operation.

ApiWikiUpdateResponse

Contains response data for the update operation.

ApiWikisListNextResponse

Contains response data for the listNext operation.

ApiWikisListResponse

Contains response data for the list operation.

ApimIdentityType

Defines values for ApimIdentityType.
KnownApimIdentityType can be used interchangeably with ApimIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

AppType

Defines values for AppType.
KnownAppType can be used interchangeably with AppType, this enum contains the known values that the service supports.

Known values supported by the service

portal: User create request was sent by legacy developer portal.
developerPortal: User create request was sent by new developer portal.

AsyncOperationStatus

Defines values for AsyncOperationStatus.

AsyncResolverStatus

Defines values for AsyncResolverStatus.

AuthorizationAccessPolicyCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

AuthorizationAccessPolicyGetResponse

Contains response data for the get operation.

AuthorizationAccessPolicyListByAuthorizationNextResponse

Contains response data for the listByAuthorizationNext operation.

AuthorizationAccessPolicyListByAuthorizationResponse

Contains response data for the listByAuthorization operation.

AuthorizationConfirmConsentCodeResponse

Contains response data for the confirmConsentCode operation.

AuthorizationCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

AuthorizationGetResponse

Contains response data for the get operation.

AuthorizationListByAuthorizationProviderNextResponse

Contains response data for the listByAuthorizationProviderNext operation.

AuthorizationListByAuthorizationProviderResponse

Contains response data for the listByAuthorizationProvider operation.

AuthorizationLoginLinksPostResponse

Contains response data for the post operation.

AuthorizationMethod

Defines values for AuthorizationMethod.

AuthorizationProviderCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

AuthorizationProviderGetResponse

Contains response data for the get operation.

AuthorizationProviderListByServiceNextResponse

Contains response data for the listByServiceNext operation.

AuthorizationProviderListByServiceResponse

Contains response data for the listByService operation.

AuthorizationServerCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

AuthorizationServerGetEntityTagResponse

Contains response data for the getEntityTag operation.

AuthorizationServerGetResponse

Contains response data for the get operation.

AuthorizationServerListByServiceNextResponse

Contains response data for the listByServiceNext operation.

AuthorizationServerListByServiceResponse

Contains response data for the listByService operation.

AuthorizationServerListSecretsResponse

Contains response data for the listSecrets operation.

AuthorizationServerUpdateResponse

Contains response data for the update operation.

AuthorizationType

Defines values for AuthorizationType.
KnownAuthorizationType can be used interchangeably with AuthorizationType, this enum contains the known values that the service supports.

Known values supported by the service

OAuth2: OAuth2 authorization type

BackendCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

BackendGetEntityTagResponse

Contains response data for the getEntityTag operation.

BackendGetResponse

Contains response data for the get operation.

BackendListByServiceNextResponse

Contains response data for the listByServiceNext operation.

BackendListByServiceResponse

Contains response data for the listByService operation.

BackendProtocol

Defines values for BackendProtocol.
KnownBackendProtocol can be used interchangeably with BackendProtocol, this enum contains the known values that the service supports.

Known values supported by the service

http: The Backend is a RESTful service.
soap: The Backend is a SOAP service.

BackendUpdateResponse

Contains response data for the update operation.

BearerTokenSendingMethod

Defines values for BearerTokenSendingMethod.
KnownBearerTokenSendingMethod can be used interchangeably with BearerTokenSendingMethod, this enum contains the known values that the service supports.

Known values supported by the service

authorizationHeader
query

BearerTokenSendingMethods

Defines values for BearerTokenSendingMethods.
KnownBearerTokenSendingMethods can be used interchangeably with BearerTokenSendingMethods, this enum contains the known values that the service supports.

Known values supported by the service

authorizationHeader: Access token will be transmitted in the Authorization header using Bearer schema
query: Access token will be transmitted as query parameters.

CacheCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

CacheGetEntityTagResponse

Contains response data for the getEntityTag operation.

CacheGetResponse

Contains response data for the get operation.

CacheListByServiceNextResponse

Contains response data for the listByServiceNext operation.

CacheListByServiceResponse

Contains response data for the listByService operation.

CacheUpdateResponse

Contains response data for the update operation.

CertificateConfigurationStoreName

Defines values for CertificateConfigurationStoreName.
KnownCertificateConfigurationStoreName can be used interchangeably with CertificateConfigurationStoreName, this enum contains the known values that the service supports.

Known values supported by the service

CertificateAuthority
Root

CertificateCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

CertificateGetEntityTagResponse

Contains response data for the getEntityTag operation.

CertificateGetResponse

Contains response data for the get operation.

CertificateListByServiceNextResponse

Contains response data for the listByServiceNext operation.

CertificateListByServiceResponse

Contains response data for the listByService operation.

CertificateRefreshSecretResponse

Contains response data for the refreshSecret operation.

CertificateSource

Defines values for CertificateSource.
KnownCertificateSource can be used interchangeably with CertificateSource, this enum contains the known values that the service supports.

Known values supported by the service

Managed
KeyVault
Custom
BuiltIn

CertificateStatus

Defines values for CertificateStatus.
KnownCertificateStatus can be used interchangeably with CertificateStatus, this enum contains the known values that the service supports.

Known values supported by the service

Completed
Failed
InProgress

ClientAuthenticationMethod

Defines values for ClientAuthenticationMethod.
KnownClientAuthenticationMethod can be used interchangeably with ClientAuthenticationMethod, this enum contains the known values that the service supports.

Known values supported by the service

Basic: Basic Client Authentication method.
Body: Body based Authentication method.

ConfigurationIdName

Defines values for ConfigurationIdName.
KnownConfigurationIdName can be used interchangeably with ConfigurationIdName, this enum contains the known values that the service supports.

Known values supported by the service

configuration

Confirmation

Defines values for Confirmation.
KnownConfirmation can be used interchangeably with Confirmation, this enum contains the known values that the service supports.

Known values supported by the service

signup: Send an e-mail to the user confirming they have successfully signed up.
invite: Send an e-mail inviting the user to sign-up and complete registration.

ConnectionStatus

Defines values for ConnectionStatus.
KnownConnectionStatus can be used interchangeably with ConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
Connected
Disconnected
Degraded

ConnectivityCheckProtocol

Defines values for ConnectivityCheckProtocol.
KnownConnectivityCheckProtocol can be used interchangeably with ConnectivityCheckProtocol, this enum contains the known values that the service supports.

Known values supported by the service

TCP
HTTP
HTTPS

ConnectivityStatusType

Defines values for ConnectivityStatusType.
KnownConnectivityStatusType can be used interchangeably with ConnectivityStatusType, this enum contains the known values that the service supports.

Known values supported by the service

initializing
success
failure

ContentFormat

Defines values for ContentFormat.
KnownContentFormat can be used interchangeably with ContentFormat, this enum contains the known values that the service supports.

Known values supported by the service

wadl-xml: The contents are inline and Content type is a WADL document.
wadl-link-json: The WADL document is hosted on a publicly accessible internet address.
swagger-json: The contents are inline and Content Type is a OpenAPI 2.0 JSON Document.
swagger-link-json: The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.
wsdl: The contents are inline and the document is a WSDL/Soap document.
wsdl-link: The WSDL document is hosted on a publicly accessible internet address.
openapi: The contents are inline and Content Type is a OpenAPI 3.0 YAML Document.
openapi+json: The contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
openapi-link: The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.
openapi+json-link: The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.
graphql-link: The GraphQL API endpoint hosted on a publicly accessible internet address.

ContentItemCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ContentItemGetEntityTagResponse

Contains response data for the getEntityTag operation.

ContentItemGetResponse

Contains response data for the get operation.

ContentItemListByServiceNextResponse

Contains response data for the listByServiceNext operation.

ContentItemListByServiceResponse

Contains response data for the listByService operation.

ContentTypeCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ContentTypeGetResponse

Contains response data for the get operation.

ContentTypeListByServiceNextResponse

Contains response data for the listByServiceNext operation.

ContentTypeListByServiceResponse

Contains response data for the listByService operation.

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

DataMaskingMode

Defines values for DataMaskingMode.
KnownDataMaskingMode can be used interchangeably with DataMaskingMode, this enum contains the known values that the service supports.

Known values supported by the service

Mask: Mask the value of an entity.
Hide: Hide the presence of an entity.

DelegationSettingsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

DelegationSettingsGetEntityTagResponse

Contains response data for the getEntityTag operation.

DelegationSettingsGetResponse

Contains response data for the get operation.

DelegationSettingsListSecretsResponse

Contains response data for the listSecrets operation.

DeletedServicesGetByNameResponse

Contains response data for the getByName operation.

DeletedServicesListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

DeletedServicesListBySubscriptionResponse

Contains response data for the listBySubscription operation.

DiagnosticCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

DiagnosticGetEntityTagResponse

Contains response data for the getEntityTag operation.

DiagnosticGetResponse

Contains response data for the get operation.

DiagnosticListByServiceNextResponse

Contains response data for the listByServiceNext operation.

DiagnosticListByServiceResponse

Contains response data for the listByService operation.

DiagnosticUpdateResponse

Contains response data for the update operation.

DocumentationCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

DocumentationGetEntityTagResponse

Contains response data for the getEntityTag operation.

DocumentationGetResponse

Contains response data for the get operation.

DocumentationListByServiceNextResponse

Contains response data for the listByServiceNext operation.

DocumentationListByServiceResponse

Contains response data for the listByService operation.

DocumentationUpdateResponse

Contains response data for the update operation.

EmailTemplateCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

EmailTemplateGetEntityTagResponse

Contains response data for the getEntityTag operation.

EmailTemplateGetResponse

Contains response data for the get operation.

EmailTemplateListByServiceNextResponse

Contains response data for the listByServiceNext operation.

EmailTemplateListByServiceResponse

Contains response data for the listByService operation.

EmailTemplateUpdateResponse

Contains response data for the update operation.

ExportApi

Defines values for ExportApi.
KnownExportApi can be used interchangeably with ExportApi, this enum contains the known values that the service supports.

Known values supported by the service

true

ExportFormat

Defines values for ExportFormat.
KnownExportFormat can be used interchangeably with ExportFormat, this enum contains the known values that the service supports.

Known values supported by the service

swagger-link: Export the Api Definition in OpenAPI 2.0 Specification as JSON document to the Storage Blob.
wsdl-link: Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for APIs of Type soap
wadl-link: Export the Api Definition in WADL Schema to Storage Blob.
openapi-link: Export the Api Definition in OpenAPI 3.0 Specification as YAML document to Storage Blob.
openapi+json-link: Export the Api Definition in OpenAPI 3.0 Specification as JSON document to Storage Blob.

ExportResultFormat

Defines values for ExportResultFormat.
KnownExportResultFormat can be used interchangeably with ExportResultFormat, this enum contains the known values that the service supports.

Known values supported by the service

swagger-link-json: The API Definition is exported in OpenAPI Specification 2.0 format to the Storage Blob.
wsdl-link+xml: The API Definition is exported in WSDL Schema to Storage Blob. This is only supported for APIs of Type soap
wadl-link-json: Export the API Definition in WADL Schema to Storage Blob.
openapi-link: Export the API Definition in OpenAPI Specification 3.0 to Storage Blob.

GatewayApiCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

GatewayApiGetEntityTagResponse

Contains response data for the getEntityTag operation.

GatewayApiListByServiceNextResponse

Contains response data for the listByServiceNext operation.

GatewayApiListByServiceResponse

Contains response data for the listByService operation.

GatewayCertificateAuthorityCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

GatewayCertificateAuthorityGetEntityTagResponse

Contains response data for the getEntityTag operation.

GatewayCertificateAuthorityGetResponse

Contains response data for the get operation.

GatewayCertificateAuthorityListByServiceNextResponse

Contains response data for the listByServiceNext operation.

GatewayCertificateAuthorityListByServiceResponse

Contains response data for the listByService operation.

GatewayCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

GatewayGenerateTokenResponse

Contains response data for the generateToken operation.

GatewayGetEntityTagResponse

Contains response data for the getEntityTag operation.

GatewayGetResponse

Contains response data for the get operation.

GatewayHostnameConfigurationCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

GatewayHostnameConfigurationGetEntityTagResponse

Contains response data for the getEntityTag operation.

GatewayHostnameConfigurationGetResponse

Contains response data for the get operation.

GatewayHostnameConfigurationListByServiceNextResponse

Contains response data for the listByServiceNext operation.

GatewayHostnameConfigurationListByServiceResponse

Contains response data for the listByService operation.

GatewayListByServiceNextResponse

Contains response data for the listByServiceNext operation.

GatewayListByServiceResponse

Contains response data for the listByService operation.

GatewayListKeysResponse

Contains response data for the listKeys operation.

GatewayUpdateResponse

Contains response data for the update operation.

GlobalSchemaCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

GlobalSchemaGetEntityTagResponse

Contains response data for the getEntityTag operation.

GlobalSchemaGetResponse

Contains response data for the get operation.

GlobalSchemaListByServiceNextResponse

Contains response data for the listByServiceNext operation.

GlobalSchemaListByServiceResponse

Contains response data for the listByService operation.

GrantType

Defines values for GrantType.
KnownGrantType can be used interchangeably with GrantType, this enum contains the known values that the service supports.

Known values supported by the service

authorizationCode: Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1.
implicit: Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2.
resourceOwnerPassword: Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3.
clientCredentials: Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4.

GraphQLApiResolverCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

GraphQLApiResolverGetEntityTagResponse

Contains response data for the getEntityTag operation.

GraphQLApiResolverGetResponse

Contains response data for the get operation.

GraphQLApiResolverListByApiNextResponse

Contains response data for the listByApiNext operation.

GraphQLApiResolverListByApiResponse

Contains response data for the listByApi operation.

GraphQLApiResolverPolicyCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

GraphQLApiResolverPolicyGetEntityTagResponse

Contains response data for the getEntityTag operation.

GraphQLApiResolverPolicyGetResponse

Contains response data for the get operation.

GraphQLApiResolverPolicyListByResolverNextResponse

Contains response data for the listByResolverNext operation.

GraphQLApiResolverPolicyListByResolverResponse

Contains response data for the listByResolver operation.

GraphQLApiResolverUpdateResponse

Contains response data for the update operation.

GroupCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

GroupGetEntityTagResponse

Contains response data for the getEntityTag operation.

GroupGetResponse

Contains response data for the get operation.

GroupListByServiceNextResponse

Contains response data for the listByServiceNext operation.

GroupListByServiceResponse

Contains response data for the listByService operation.

GroupType

Defines values for GroupType.

GroupUpdateResponse

Contains response data for the update operation.

GroupUserCheckEntityExistsResponse

Contains response data for the checkEntityExists operation.

GroupUserCreateResponse

Contains response data for the create operation.

GroupUserListNextResponse

Contains response data for the listNext operation.

GroupUserListResponse

Contains response data for the list operation.

HostnameType

Defines values for HostnameType.
KnownHostnameType can be used interchangeably with HostnameType, this enum contains the known values that the service supports.

Known values supported by the service

Proxy
Portal
Management
Scm
DeveloperPortal

HttpCorrelationProtocol

Defines values for HttpCorrelationProtocol.
KnownHttpCorrelationProtocol can be used interchangeably with HttpCorrelationProtocol, this enum contains the known values that the service supports.

Known values supported by the service

None: Do not read and inject correlation headers.
Legacy: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
W3C: Inject Trace Context headers. See https://w3c.github.io/trace-context.

IdentityProviderCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

IdentityProviderGetEntityTagResponse

Contains response data for the getEntityTag operation.

IdentityProviderGetResponse

Contains response data for the get operation.

IdentityProviderListByServiceNextResponse

Contains response data for the listByServiceNext operation.

IdentityProviderListByServiceResponse

Contains response data for the listByService operation.

IdentityProviderListSecretsResponse

Contains response data for the listSecrets operation.

IdentityProviderType

Defines values for IdentityProviderType.
KnownIdentityProviderType can be used interchangeably with IdentityProviderType, this enum contains the known values that the service supports.

Known values supported by the service

facebook: Facebook as Identity provider.
google: Google as Identity provider.
microsoft: Microsoft Live as Identity provider.
twitter: Twitter as Identity provider.
aad: Azure Active Directory as Identity provider.
aadB2C: Azure Active Directory B2C as Identity provider.

IdentityProviderUpdateResponse

Contains response data for the update operation.

IssueGetResponse

Contains response data for the get operation.

IssueListByServiceNextResponse

Contains response data for the listByServiceNext operation.

IssueListByServiceResponse

Contains response data for the listByService operation.

IssueType

Defines values for IssueType.
KnownIssueType can be used interchangeably with IssueType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
AgentStopped
GuestFirewall
DnsResolution
SocketBind
NetworkSecurityRule
UserDefinedRoute
PortThrottled
Platform

KeyType

Defines values for KeyType.

LoggerCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

LoggerGetEntityTagResponse

Contains response data for the getEntityTag operation.

LoggerGetResponse

Contains response data for the get operation.

LoggerListByServiceNextResponse

Contains response data for the listByServiceNext operation.

LoggerListByServiceResponse

Contains response data for the listByService operation.

LoggerType

Defines values for LoggerType.
KnownLoggerType can be used interchangeably with LoggerType, this enum contains the known values that the service supports.

Known values supported by the service

azureEventHub: Azure Event Hub as log destination.
applicationInsights: Azure Application Insights as log destination.
azureMonitor: Azure Monitor

LoggerUpdateResponse

Contains response data for the update operation.

Method

Defines values for Method.
KnownMethod can be used interchangeably with Method, this enum contains the known values that the service supports.

Known values supported by the service

GET
POST

NameAvailabilityReason

Defines values for NameAvailabilityReason.

NamedValueCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

NamedValueGetEntityTagResponse

Contains response data for the getEntityTag operation.

NamedValueGetResponse

Contains response data for the get operation.

NamedValueListByServiceNextResponse

Contains response data for the listByServiceNext operation.

NamedValueListByServiceResponse

Contains response data for the listByService operation.

NamedValueListValueResponse

Contains response data for the listValue operation.

NamedValueRefreshSecretResponse

Contains response data for the refreshSecret operation.

NamedValueUpdateResponse

Contains response data for the update operation.

NatGatewayState

Defines values for NatGatewayState.
KnownNatGatewayState can be used interchangeably with NatGatewayState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Nat Gateway is enabled for the service.
Disabled: Nat Gateway is disabled for the service.

NetworkStatusListByLocationResponse

Contains response data for the listByLocation operation.

NetworkStatusListByServiceResponse

Contains response data for the listByService operation.

NotificationCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

NotificationGetResponse

Contains response data for the get operation.

NotificationListByServiceNextResponse

Contains response data for the listByServiceNext operation.

NotificationListByServiceResponse

Contains response data for the listByService operation.

NotificationName

Defines values for NotificationName.
KnownNotificationName can be used interchangeably with NotificationName, this enum contains the known values that the service supports.

Known values supported by the service

RequestPublisherNotificationMessage: The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.
PurchasePublisherNotificationMessage: The following email recipients and users will receive email notifications about new API product subscriptions.
NewApplicationNotificationMessage: The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.
BCC: The following recipients will receive blind carbon copies of all emails sent to developers.
NewIssuePublisherNotificationMessage: The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.
AccountClosedPublisher: The following email recipients and users will receive email notifications when developer closes his account.
QuotaLimitApproachingPublisherNotificationMessage: The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.

NotificationRecipientEmailCheckEntityExistsResponse

Contains response data for the checkEntityExists operation.

NotificationRecipientEmailCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

NotificationRecipientEmailListByNotificationResponse

Contains response data for the listByNotification operation.

NotificationRecipientUserCheckEntityExistsResponse

Contains response data for the checkEntityExists operation.

NotificationRecipientUserCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

NotificationRecipientUserListByNotificationResponse

Contains response data for the listByNotification operation.

OAuth2GrantType

Defines values for OAuth2GrantType.
KnownOAuth2GrantType can be used interchangeably with OAuth2GrantType, this enum contains the known values that the service supports.

Known values supported by the service

AuthorizationCode: Authorization Code grant
ClientCredentials: Client Credential grant

OpenIdConnectProviderCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

OpenIdConnectProviderGetEntityTagResponse

Contains response data for the getEntityTag operation.

OpenIdConnectProviderGetResponse

Contains response data for the get operation.

OpenIdConnectProviderListByServiceNextResponse

Contains response data for the listByServiceNext operation.

OpenIdConnectProviderListByServiceResponse

Contains response data for the listByService operation.

OpenIdConnectProviderListSecretsResponse

Contains response data for the listSecrets operation.

OpenIdConnectProviderUpdateResponse

Contains response data for the update operation.

OperationListByTagsNextResponse

Contains response data for the listByTagsNext operation.

OperationListByTagsResponse

Contains response data for the listByTags operation.

OperationNameFormat

Defines values for OperationNameFormat.
KnownOperationNameFormat can be used interchangeably with OperationNameFormat, this enum contains the known values that the service supports.

Known values supported by the service

Name: API_NAME;rev=API_REVISION - OPERATION_NAME
Url: HTTP_VERB URL

Origin

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

Local
Inbound
Outbound

OutboundNetworkDependenciesEndpointsListByServiceResponse

Contains response data for the listByService operation.

PerformConnectivityCheckAsyncResponse

Contains response data for the performConnectivityCheckAsync operation.

PlatformVersion

Defines values for PlatformVersion.
KnownPlatformVersion can be used interchangeably with PlatformVersion, this enum contains the known values that the service supports.

Known values supported by the service

undetermined: Platform version cannot be determined, as compute platform is not deployed.
stv1: Platform running the service on Single Tenant V1 platform.
stv2: Platform running the service on Single Tenant V2 platform.
mtv1: Platform running the service on Multi Tenant V1 platform.

PolicyContentFormat

Defines values for PolicyContentFormat.
KnownPolicyContentFormat can be used interchangeably with PolicyContentFormat, this enum contains the known values that the service supports.

Known values supported by the service

xml: The contents are inline and Content type is an XML document.
xml-link: The policy XML document is hosted on a HTTP endpoint accessible from the API Management service.
rawxml: The contents are inline and Content type is a non XML encoded policy document.
rawxml-link: The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service.

PolicyCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

PolicyDescriptionListByServiceResponse

Contains response data for the listByService operation.

PolicyExportFormat

Defines values for PolicyExportFormat.
KnownPolicyExportFormat can be used interchangeably with PolicyExportFormat, this enum contains the known values that the service supports.

Known values supported by the service

xml: The contents are inline and Content type is an XML document.
rawxml: The contents are inline and Content type is a non XML encoded policy document.

PolicyFragmentContentFormat

Defines values for PolicyFragmentContentFormat.
KnownPolicyFragmentContentFormat can be used interchangeably with PolicyFragmentContentFormat, this enum contains the known values that the service supports.

Known values supported by the service

xml: The contents are inline and Content type is an XML document.
rawxml: The contents are inline and Content type is a non XML encoded policy document.

PolicyFragmentCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

PolicyFragmentGetEntityTagResponse

Contains response data for the getEntityTag operation.

PolicyFragmentGetResponse

Contains response data for the get operation.

PolicyFragmentListByServiceResponse

Contains response data for the listByService operation.

PolicyFragmentListReferencesResponse

Contains response data for the listReferences operation.

PolicyGetEntityTagResponse

Contains response data for the getEntityTag operation.

PolicyGetResponse

Contains response data for the get operation.

PolicyIdName

Defines values for PolicyIdName.
KnownPolicyIdName can be used interchangeably with PolicyIdName, this enum contains the known values that the service supports.

Known values supported by the service

policy

PolicyListByServiceResponse

Contains response data for the listByService operation.

PolicyScopeContract

Defines values for PolicyScopeContract.

PortalConfigCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

PortalConfigGetEntityTagResponse

Contains response data for the getEntityTag operation.

PortalConfigGetResponse

Contains response data for the get operation.

PortalConfigListByServiceResponse

Contains response data for the listByService operation.

PortalConfigUpdateResponse

Contains response data for the update operation.

PortalRevisionCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

PortalRevisionGetEntityTagResponse

Contains response data for the getEntityTag operation.

PortalRevisionGetResponse

Contains response data for the get operation.

PortalRevisionListByServiceNextResponse

Contains response data for the listByServiceNext operation.

PortalRevisionListByServiceResponse

Contains response data for the listByService operation.

PortalRevisionStatus

Defines values for PortalRevisionStatus.
KnownPortalRevisionStatus can be used interchangeably with PortalRevisionStatus, this enum contains the known values that the service supports.

Known values supported by the service

pending: Portal's revision has been queued.
publishing: Portal's revision is being published.
completed: Portal's revision publishing completed.
failed: Portal's revision publishing failed.

PortalRevisionUpdateResponse

Contains response data for the update operation.

PortalSettingsCspMode

Defines values for PortalSettingsCspMode.
KnownPortalSettingsCspMode can be used interchangeably with PortalSettingsCspMode, this enum contains the known values that the service supports.

Known values supported by the service

enabled: The browser will block requests not matching allowed origins.
disabled: The browser will not apply the origin restrictions.
reportOnly: The browser will report requests not matching allowed origins without blocking them.

PortalSettingsListByServiceResponse

Contains response data for the listByService operation.

PreferredIPVersion

Defines values for PreferredIPVersion.
KnownPreferredIPVersion can be used interchangeably with PreferredIPVersion, this enum contains the known values that the service supports.

Known values supported by the service

IPv4

PrivateEndpointConnectionCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

PrivateEndpointConnectionGetByNameResponse

Contains response data for the getByName operation.

PrivateEndpointConnectionGetPrivateLinkResourceResponse

Contains response data for the getPrivateLinkResource operation.

PrivateEndpointConnectionListByServiceResponse

Contains response data for the listByService operation.

PrivateEndpointConnectionListPrivateLinkResourcesResponse

Contains response data for the listPrivateLinkResources operation.

PrivateEndpointConnectionProvisioningState

Defines values for PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

Defines values for PrivateEndpointServiceConnectionStatus.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected

ProductApiCheckEntityExistsResponse

Contains response data for the checkEntityExists operation.

ProductApiCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ProductApiListByProductNextResponse

Contains response data for the listByProductNext operation.

ProductApiListByProductResponse

Contains response data for the listByProduct operation.

ProductCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ProductGetEntityTagResponse

Contains response data for the getEntityTag operation.

ProductGetResponse

Contains response data for the get operation.

ProductGroupCheckEntityExistsResponse

Contains response data for the checkEntityExists operation.

ProductGroupCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ProductGroupListByProductNextResponse

Contains response data for the listByProductNext operation.

ProductGroupListByProductResponse

Contains response data for the listByProduct operation.

ProductListByServiceNextResponse

Contains response data for the listByServiceNext operation.

ProductListByServiceResponse

Contains response data for the listByService operation.

ProductListByTagsNextResponse

Contains response data for the listByTagsNext operation.

ProductListByTagsResponse

Contains response data for the listByTags operation.

ProductPolicyCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ProductPolicyGetEntityTagResponse

Contains response data for the getEntityTag operation.

ProductPolicyGetResponse

Contains response data for the get operation.

ProductPolicyListByProductResponse

Contains response data for the listByProduct operation.

ProductState

Defines values for ProductState.

ProductSubscriptionsListNextResponse

Contains response data for the listNext operation.

ProductSubscriptionsListResponse

Contains response data for the list operation.

ProductUpdateResponse

Contains response data for the update operation.

ProductWikiCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ProductWikiGetEntityTagResponse

Contains response data for the getEntityTag operation.

ProductWikiGetResponse

Contains response data for the get operation.

ProductWikiUpdateResponse

Contains response data for the update operation.

ProductWikisListNextResponse

Contains response data for the listNext operation.

ProductWikisListResponse

Contains response data for the list operation.

Protocol

Defines values for Protocol.
KnownProtocol can be used interchangeably with Protocol, this enum contains the known values that the service supports.

Known values supported by the service

http
https
ws
wss

PublicNetworkAccess

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

QuotaByCounterKeysListByServiceResponse

Contains response data for the listByService operation.

QuotaByCounterKeysUpdateResponse

Contains response data for the update operation.

QuotaByPeriodKeysGetResponse

Contains response data for the get operation.

QuotaByPeriodKeysUpdateResponse

Contains response data for the update operation.

RegionListByServiceNextResponse

Contains response data for the listByServiceNext operation.

RegionListByServiceResponse

Contains response data for the listByService operation.

ReportsListByApiNextResponse

Contains response data for the listByApiNext operation.

ReportsListByApiResponse

Contains response data for the listByApi operation.

ReportsListByGeoNextResponse

Contains response data for the listByGeoNext operation.

ReportsListByGeoResponse

Contains response data for the listByGeo operation.

ReportsListByOperationNextResponse

Contains response data for the listByOperationNext operation.

ReportsListByOperationResponse

Contains response data for the listByOperation operation.

ReportsListByProductNextResponse

Contains response data for the listByProductNext operation.

ReportsListByProductResponse

Contains response data for the listByProduct operation.

ReportsListByRequestResponse

Contains response data for the listByRequest operation.

ReportsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

ReportsListBySubscriptionResponse

Contains response data for the listBySubscription operation.

ReportsListByTimeNextResponse

Contains response data for the listByTimeNext operation.

ReportsListByTimeResponse

Contains response data for the listByTime operation.

ReportsListByUserNextResponse

Contains response data for the listByUserNext operation.

ReportsListByUserResponse

Contains response data for the listByUser operation.

ResourceSkuCapacityScaleType

Defines values for ResourceSkuCapacityScaleType.
KnownResourceSkuCapacityScaleType can be used interchangeably with ResourceSkuCapacityScaleType, this enum contains the known values that the service supports.

Known values supported by the service

automatic: Supported scale type automatic.
manual: Supported scale type manual.
none: Scaling not supported.

SamplingType

Defines values for SamplingType.
KnownSamplingType can be used interchangeably with SamplingType, this enum contains the known values that the service supports.

Known values supported by the service

fixed: Fixed-rate sampling.

SchemaType

Defines values for SchemaType.
KnownSchemaType can be used interchangeably with SchemaType, this enum contains the known values that the service supports.

Known values supported by the service

xml: XML schema type.
json: Json schema type.

SettingsTypeName

Defines values for SettingsTypeName.
KnownSettingsTypeName can be used interchangeably with SettingsTypeName, this enum contains the known values that the service supports.

Known values supported by the service

public

Severity

Defines values for Severity.
KnownSeverity can be used interchangeably with Severity, this enum contains the known values that the service supports.

Known values supported by the service

Error
Warning

SignInSettingsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

SignInSettingsGetEntityTagResponse

Contains response data for the getEntityTag operation.

SignInSettingsGetResponse

Contains response data for the get operation.

SignUpSettingsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

SignUpSettingsGetEntityTagResponse

Contains response data for the getEntityTag operation.

SignUpSettingsGetResponse

Contains response data for the get operation.

SkuType

Defines values for SkuType.
KnownSkuType can be used interchangeably with SkuType, this enum contains the known values that the service supports.

Known values supported by the service

Developer: Developer SKU of Api Management.
Standard: Standard SKU of Api Management.
Premium: Premium SKU of Api Management.
Basic: Basic SKU of Api Management.
Consumption: Consumption SKU of Api Management.
Isolated: Isolated SKU of Api Management.

SoapApiType

Defines values for SoapApiType.
KnownSoapApiType can be used interchangeably with SoapApiType, this enum contains the known values that the service supports.

Known values supported by the service

http: Imports a SOAP API having a RESTful front end.
soap: Imports the SOAP API having a SOAP front end.
websocket: Imports the API having a Websocket front end.
graphql: Imports the API having a GraphQL front end.

State

Defines values for State.
KnownState can be used interchangeably with State, this enum contains the known values that the service supports.

Known values supported by the service

proposed: The issue is proposed.
open: The issue is opened.
removed: The issue was removed.
resolved: The issue is now resolved.
closed: The issue was closed.

SubscriptionCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

SubscriptionGetEntityTagResponse

Contains response data for the getEntityTag operation.

SubscriptionGetResponse

Contains response data for the get operation.

SubscriptionListNextResponse

Contains response data for the listNext operation.

SubscriptionListResponse

Contains response data for the list operation.

SubscriptionListSecretsResponse

Contains response data for the listSecrets operation.

SubscriptionState

Defines values for SubscriptionState.

SubscriptionUpdateResponse

Contains response data for the update operation.

TagAssignToApiResponse

Contains response data for the assignToApi operation.

TagAssignToOperationResponse

Contains response data for the assignToOperation operation.

TagAssignToProductResponse

Contains response data for the assignToProduct operation.

TagCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

TagGetByApiResponse

Contains response data for the getByApi operation.

TagGetByOperationResponse

Contains response data for the getByOperation operation.

TagGetByProductResponse

Contains response data for the getByProduct operation.

TagGetEntityStateByApiResponse

Contains response data for the getEntityStateByApi operation.

TagGetEntityStateByOperationResponse

Contains response data for the getEntityStateByOperation operation.

TagGetEntityStateByProductResponse

Contains response data for the getEntityStateByProduct operation.

TagGetEntityStateResponse

Contains response data for the getEntityState operation.

TagGetResponse

Contains response data for the get operation.

TagListByApiNextResponse

Contains response data for the listByApiNext operation.

TagListByApiResponse

Contains response data for the listByApi operation.

TagListByOperationNextResponse

Contains response data for the listByOperationNext operation.

TagListByOperationResponse

Contains response data for the listByOperation operation.

TagListByProductNextResponse

Contains response data for the listByProductNext operation.

TagListByProductResponse

Contains response data for the listByProduct operation.

TagListByServiceNextResponse

Contains response data for the listByServiceNext operation.

TagListByServiceResponse

Contains response data for the listByService operation.

TagResourceListByServiceNextResponse

Contains response data for the listByServiceNext operation.

TagResourceListByServiceResponse

Contains response data for the listByService operation.

TagUpdateResponse

Contains response data for the update operation.

TemplateName

Defines values for TemplateName.
KnownTemplateName can be used interchangeably with TemplateName, this enum contains the known values that the service supports.

Known values supported by the service

applicationApprovedNotificationMessage
accountClosedDeveloper
quotaLimitApproachingDeveloperNotificationMessage
newDeveloperNotificationMessage
emailChangeIdentityDefault
inviteUserNotificationMessage
newCommentNotificationMessage
confirmSignUpIdentityDefault
newIssueNotificationMessage
purchaseDeveloperNotificationMessage
passwordResetIdentityDefault
passwordResetByAdminNotificationMessage
rejectDeveloperNotificationMessage
requestDeveloperNotificationMessage

TenantAccessCreateResponse

Contains response data for the create operation.

TenantAccessGetEntityTagResponse

Contains response data for the getEntityTag operation.

TenantAccessGetResponse

Contains response data for the get operation.

TenantAccessListByServiceNextResponse

Contains response data for the listByServiceNext operation.

TenantAccessListByServiceResponse

Contains response data for the listByService operation.

TenantAccessListSecretsResponse

Contains response data for the listSecrets operation.

TenantAccessUpdateResponse

Contains response data for the update operation.

TenantConfigurationDeployResponse

Contains response data for the deploy operation.

TenantConfigurationGetSyncStateResponse

Contains response data for the getSyncState operation.

TenantConfigurationSaveResponse

Contains response data for the save operation.

TenantConfigurationValidateResponse

Contains response data for the validate operation.

TenantSettingsGetResponse

Contains response data for the get operation.

TenantSettingsListByServiceNextResponse

Contains response data for the listByServiceNext operation.

TenantSettingsListByServiceResponse

Contains response data for the listByService operation.

TranslateRequiredQueryParametersConduct

Defines values for TranslateRequiredQueryParametersConduct.
KnownTranslateRequiredQueryParametersConduct can be used interchangeably with TranslateRequiredQueryParametersConduct, this enum contains the known values that the service supports.

Known values supported by the service

template: Translates required query parameters to template ones. Is a default value
query: Leaves required query parameters as they are (no translation done).

UserCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

UserGenerateSsoUrlResponse

Contains response data for the generateSsoUrl operation.

UserGetEntityTagResponse

Contains response data for the getEntityTag operation.

UserGetResponse

Contains response data for the get operation.

UserGetSharedAccessTokenResponse

Contains response data for the getSharedAccessToken operation.

UserGroupListNextResponse

Contains response data for the listNext operation.

UserGroupListResponse

Contains response data for the list operation.

UserIdentitiesListNextResponse

Contains response data for the listNext operation.

UserIdentitiesListResponse

Contains response data for the list operation.

UserListByServiceNextResponse

Contains response data for the listByServiceNext operation.

UserListByServiceResponse

Contains response data for the listByService operation.

UserState

Defines values for UserState.
KnownUserState can be used interchangeably with UserState, this enum contains the known values that the service supports.

Known values supported by the service

active: User state is active.
blocked: User is blocked. Blocked users cannot authenticate at developer portal or call API.
pending: User account is pending. Requires identity confirmation before it can be made active.
deleted: User account is closed. All identities and related entities are removed.

UserSubscriptionGetResponse

Contains response data for the get operation.

UserSubscriptionListNextResponse

Contains response data for the listNext operation.

UserSubscriptionListResponse

Contains response data for the list operation.

UserUpdateResponse

Contains response data for the update operation.

Verbosity

Defines values for Verbosity.
KnownVerbosity can be used interchangeably with Verbosity, this enum contains the known values that the service supports.

Known values supported by the service

verbose: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.
information: Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.
error: Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.

VersioningScheme

Defines values for VersioningScheme.
KnownVersioningScheme can be used interchangeably with VersioningScheme, this enum contains the known values that the service supports.

Known values supported by the service

Segment: The API Version is passed in a path segment.
Query: The API Version is passed in a query parameter.
Header: The API Version is passed in a HTTP header.

VirtualNetworkType

Defines values for VirtualNetworkType.
KnownVirtualNetworkType can be used interchangeably with VirtualNetworkType, this enum contains the known values that the service supports.

Known values supported by the service

None: The service is not part of any Virtual Network.
External: The service is part of Virtual Network and it is accessible from Internet.
Internal: The service is part of Virtual Network and it is only accessible from within the virtual network.

Enums

KnownAccessIdName

Known values of AccessIdName that the service accepts.

KnownAccessType

Known values of AccessType that the service accepts.

KnownAlwaysLog

Known values of AlwaysLog that the service accepts.

KnownApiType

Known values of ApiType that the service accepts.

KnownApiVersionSetContractDetailsVersioningScheme

Known values of ApiVersionSetContractDetailsVersioningScheme that the service accepts.

KnownApimIdentityType

Known values of ApimIdentityType that the service accepts.

KnownAppType

Known values of AppType that the service accepts.

KnownAuthorizationType

Known values of AuthorizationType that the service accepts.

KnownBackendProtocol

Known values of BackendProtocol that the service accepts.

KnownBearerTokenSendingMethod

Known values of BearerTokenSendingMethod that the service accepts.

KnownBearerTokenSendingMethods

Known values of BearerTokenSendingMethods that the service accepts.

KnownCertificateConfigurationStoreName

Known values of CertificateConfigurationStoreName that the service accepts.

KnownCertificateSource

Known values of CertificateSource that the service accepts.

KnownCertificateStatus

Known values of CertificateStatus that the service accepts.

KnownClientAuthenticationMethod

Known values of ClientAuthenticationMethod that the service accepts.

KnownConfigurationIdName

Known values of ConfigurationIdName that the service accepts.

KnownConfirmation

Known values of Confirmation that the service accepts.

KnownConnectionStatus

Known values of ConnectionStatus that the service accepts.

KnownConnectivityCheckProtocol

Known values of ConnectivityCheckProtocol that the service accepts.

KnownConnectivityStatusType

Known values of ConnectivityStatusType that the service accepts.

KnownContentFormat

Known values of ContentFormat that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownDataMaskingMode

Known values of DataMaskingMode that the service accepts.

KnownExportApi

Known values of ExportApi that the service accepts.

KnownExportFormat

Known values of ExportFormat that the service accepts.

KnownExportResultFormat

Known values of ExportResultFormat that the service accepts.

KnownGrantType

Known values of GrantType that the service accepts.

KnownHostnameType

Known values of HostnameType that the service accepts.

KnownHttpCorrelationProtocol

Known values of HttpCorrelationProtocol that the service accepts.

KnownIdentityProviderType

Known values of IdentityProviderType that the service accepts.

KnownIssueType

Known values of IssueType that the service accepts.

KnownLoggerType

Known values of LoggerType that the service accepts.

KnownMethod

Known values of Method that the service accepts.

KnownNatGatewayState

Known values of NatGatewayState that the service accepts.

KnownNotificationName

Known values of NotificationName that the service accepts.

KnownOAuth2GrantType

Known values of OAuth2GrantType that the service accepts.

KnownOperationNameFormat

Known values of OperationNameFormat that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownPlatformVersion

Known values of PlatformVersion that the service accepts.

KnownPolicyContentFormat

Known values of PolicyContentFormat that the service accepts.

KnownPolicyExportFormat

Known values of PolicyExportFormat that the service accepts.

KnownPolicyFragmentContentFormat

Known values of PolicyFragmentContentFormat that the service accepts.

KnownPolicyIdName

Known values of PolicyIdName that the service accepts.

KnownPortalRevisionStatus

Known values of PortalRevisionStatus that the service accepts.

KnownPortalSettingsCspMode

Known values of PortalSettingsCspMode that the service accepts.

KnownPreferredIPVersion

Known values of PreferredIPVersion that the service accepts.

KnownPrivateEndpointConnectionProvisioningState

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

KnownPrivateEndpointServiceConnectionStatus

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

KnownProtocol

Known values of Protocol that the service accepts.

KnownPublicNetworkAccess

Known values of PublicNetworkAccess that the service accepts.

KnownResourceSkuCapacityScaleType

Known values of ResourceSkuCapacityScaleType that the service accepts.

KnownSamplingType

Known values of SamplingType that the service accepts.

KnownSchemaType

Known values of SchemaType that the service accepts.

KnownSettingsTypeName

Known values of SettingsTypeName that the service accepts.

KnownSeverity

Known values of Severity that the service accepts.

KnownSkuType

Known values of SkuType that the service accepts.

KnownSoapApiType

Known values of SoapApiType that the service accepts.

KnownState

Known values of State that the service accepts.

KnownTemplateName

Known values of TemplateName that the service accepts.

KnownTranslateRequiredQueryParametersConduct

Known values of TranslateRequiredQueryParametersConduct that the service accepts.

KnownUserState

Known values of UserState that the service accepts.

KnownVerbosity

Known values of Verbosity that the service accepts.

KnownVersioningScheme

Known values of VersioningScheme that the service accepts.

KnownVirtualNetworkType

Known values of VirtualNetworkType that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.