Azure.Provisioning.ApiManagement Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| Name | Description |
|---|---|
| AdditionalLocation |
Description of an additional API Management resource location. |
| ApiContactInformation |
API contact information. |
| ApiCreateOrUpdatePropertiesWsdlSelector |
Criteria to limit import of WSDL to a subset of the document. |
| ApiDiagnostic |
ApiDiagnostic. |
| ApiDiagnostic.ResourceVersions |
Supported ApiDiagnostic resource versions. |
| ApiGateway |
ApiGateway. |
| ApiGateway.ResourceVersions |
Supported ApiGateway resource versions. |
| ApiGatewayConfigConnection |
ApiGatewayConfigConnection. |
| ApiGatewayConfigConnection.ResourceVersions |
Supported ApiGatewayConfigConnection resource versions. |
| ApiIssue |
ApiIssue. |
| ApiIssue.ResourceVersions |
Supported ApiIssue resource versions. |
| ApiIssueAttachment |
ApiIssueAttachment. |
| ApiIssueAttachment.ResourceVersions |
Supported ApiIssueAttachment resource versions. |
| ApiIssueComment |
ApiIssueComment. |
| ApiIssueComment.ResourceVersions |
Supported ApiIssueComment resource versions. |
| ApiLicenseInformation |
API license information. |
| ApiManagementApi |
ApiManagementApi. |
| ApiManagementApi.ResourceVersions |
Supported ApiManagementApi resource versions. |
| ApiManagementAuthorizationError |
Authorization error details. |
| ApiManagementAuthorizationServer |
ApiManagementAuthorizationServer. |
| ApiManagementAuthorizationServer.ResourceVersions |
Supported ApiManagementAuthorizationServer resource versions. |
| ApiManagementBackend |
ApiManagementBackend. |
| ApiManagementBackend.ResourceVersions |
Supported ApiManagementBackend resource versions. |
| ApiManagementCache |
ApiManagementCache. |
| ApiManagementCache.ResourceVersions |
Supported ApiManagementCache resource versions. |
| ApiManagementCertificate |
ApiManagementCertificate. |
| ApiManagementCertificate.ResourceVersions |
Supported ApiManagementCertificate resource versions. |
| ApiManagementDiagnostic |
ApiManagementDiagnostic. |
| ApiManagementDiagnostic.ResourceVersions |
Supported ApiManagementDiagnostic resource versions. |
| ApiManagementEmailTemplate |
ApiManagementEmailTemplate. |
| ApiManagementEmailTemplate.ResourceVersions |
Supported ApiManagementEmailTemplate resource versions. |
| ApiManagementGateway |
ApiManagementGateway. |
| ApiManagementGateway.ResourceVersions |
Supported ApiManagementGateway resource versions. |
| ApiManagementGatewayCertificateAuthority |
ApiManagementGatewayCertificateAuthority. |
| ApiManagementGatewayCertificateAuthority.ResourceVersions |
Supported ApiManagementGatewayCertificateAuthority resource versions. |
| ApiManagementGatewayHostnameConfiguration |
ApiManagementGatewayHostnameConfiguration. |
| ApiManagementGatewayHostnameConfiguration.ResourceVersions |
Supported ApiManagementGatewayHostnameConfiguration resource versions. |
| ApiManagementGatewaySkuProperties |
API Management gateway resource SKU properties. |
| ApiManagementGlobalSchema |
ApiManagementGlobalSchema. |
| ApiManagementGlobalSchema.ResourceVersions |
Supported ApiManagementGlobalSchema resource versions. |
| ApiManagementGroup |
ApiManagementGroup. |
| ApiManagementGroup.ResourceVersions |
Supported ApiManagementGroup resource versions. |
| ApiManagementIdentityProvider |
ApiManagementIdentityProvider. |
| ApiManagementIdentityProvider.ResourceVersions |
Supported ApiManagementIdentityProvider resource versions. |
| ApiManagementLogger |
ApiManagementLogger. |
| ApiManagementLogger.ResourceVersions |
Supported ApiManagementLogger resource versions. |
| ApiManagementNamedValue |
ApiManagementNamedValue. |
| ApiManagementNamedValue.ResourceVersions |
Supported ApiManagementNamedValue resource versions. |
| ApiManagementNotification |
ApiManagementNotification. |
| ApiManagementNotification.ResourceVersions |
Supported ApiManagementNotification resource versions. |
| ApiManagementOpenIdConnectProvider |
ApiManagementOpenIdConnectProvider. |
| ApiManagementOpenIdConnectProvider.ResourceVersions |
Supported ApiManagementOpenIdConnectProvider resource versions. |
| ApiManagementPolicy |
ApiManagementPolicy. |
| ApiManagementPolicy.ResourceVersions |
Supported ApiManagementPolicy resource versions. |
| ApiManagementPortalDelegationSetting |
ApiManagementPortalDelegationSetting. |
| ApiManagementPortalDelegationSetting.ResourceVersions |
Supported ApiManagementPortalDelegationSetting resource versions. |
| ApiManagementPortalRevision |
ApiManagementPortalRevision. |
| ApiManagementPortalRevision.ResourceVersions |
Supported ApiManagementPortalRevision resource versions. |
| ApiManagementPortalSignInSetting |
ApiManagementPortalSignInSetting. |
| ApiManagementPortalSignInSetting.ResourceVersions |
Supported ApiManagementPortalSignInSetting resource versions. |
| ApiManagementPortalSignUpSetting |
ApiManagementPortalSignUpSetting. |
| ApiManagementPortalSignUpSetting.ResourceVersions |
Supported ApiManagementPortalSignUpSetting resource versions. |
| ApiManagementPrivateEndpointConnection |
ApiManagementPrivateEndpointConnection. |
| ApiManagementPrivateEndpointConnection.ResourceVersions |
Supported ApiManagementPrivateEndpointConnection resource versions. |
| ApiManagementPrivateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
| ApiManagementProduct |
ApiManagementProduct. |
| ApiManagementProduct.ResourceVersions |
Supported ApiManagementProduct resource versions. |
| ApiManagementProductPolicy |
ApiManagementProductPolicy. |
| ApiManagementProductPolicy.ResourceVersions |
Supported ApiManagementProductPolicy resource versions. |
| ApiManagementProductTag |
ApiManagementProductTag. |
| ApiManagementProductTag.ResourceVersions |
Supported ApiManagementProductTag resource versions. |
| ApiManagementService |
ApiManagementService. |
| ApiManagementService.ResourceVersions |
Supported ApiManagementService resource versions. |
| ApiManagementServiceSkuProperties |
API Management service resource SKU properties. |
| ApiManagementSubscription |
ApiManagementSubscription. |
| ApiManagementSubscription.ResourceVersions |
Supported ApiManagementSubscription resource versions. |
| ApiManagementTag |
ApiManagementTag. |
| ApiManagementTag.ResourceVersions |
Supported ApiManagementTag resource versions. |
| ApiManagementUser |
ApiManagementUser. |
| ApiManagementUser.ResourceVersions |
Supported ApiManagementUser resource versions. |
| ApiOperation |
ApiOperation. |
| ApiOperation.ResourceVersions |
Supported ApiOperation resource versions. |
| ApiOperationPolicy |
ApiOperationPolicy. |
| ApiOperationPolicy.ResourceVersions |
Supported ApiOperationPolicy resource versions. |
| ApiOperationTag |
ApiOperationTag. |
| ApiOperationTag.ResourceVersions |
Supported ApiOperationTag resource versions. |
| ApiPolicy |
ApiPolicy. |
| ApiPolicy.ResourceVersions |
Supported ApiPolicy resource versions. |
| ApiRelease |
ApiRelease. |
| ApiRelease.ResourceVersions |
Supported ApiRelease resource versions. |
| ApiSchema |
ApiSchema. |
| ApiSchema.ResourceVersions |
Supported ApiSchema resource versions. |
| ApiTag |
ApiTag. |
| ApiTag.ResourceVersions |
Supported ApiTag resource versions. |
| ApiTagDescription |
ApiTagDescription. |
| ApiTagDescription.ResourceVersions |
Supported ApiTagDescription resource versions. |
| ApiVersionSet |
ApiVersionSet. |
| ApiVersionSet.ResourceVersions |
Supported ApiVersionSet resource versions. |
| ApiVersionSetContractDetails |
An API Version Set contains the common configuration for a set of API Versions relating. |
| AuthenticationSettingsContract |
API Authentication Settings. |
| AuthorizationAccessPolicyContract |
AuthorizationAccessPolicyContract. |
| AuthorizationAccessPolicyContract.ResourceVersions |
Supported AuthorizationAccessPolicyContract resource versions. |
| AuthorizationContract |
AuthorizationContract. |
| AuthorizationContract.ResourceVersions |
Supported AuthorizationContract resource versions. |
| AuthorizationProviderContract |
AuthorizationProviderContract. |
| AuthorizationProviderContract.ResourceVersions |
Supported AuthorizationProviderContract resource versions. |
| AuthorizationProviderOAuth2GrantTypes |
Authorization Provider oauth2 grant types settings. |
| AuthorizationProviderOAuth2Settings |
OAuth2 settings details. |
| BackendAuthorizationHeaderCredentials |
Authorization header information. |
| BackendCredentialsContract |
Details of the Credentials used to connect to Backend. |
| BackendPoolItem |
Backend pool service information. |
| BackendProxyContract |
Details of the Backend WebProxy Server to use in the Request to Backend. |
| BackendServiceFabricClusterProperties |
Properties of the Service Fabric Type Backend. |
| BackendTlsProperties |
Properties controlling TLS Certificate Validation. |
| CertificateConfiguration |
Certificate configuration which consist of non-trusted intermediates and root certificates. |
| CertificateInformation |
SSL certificate information. |
| CircuitBreakerFailureCondition |
The trip conditions of the circuit breaker. |
| CircuitBreakerRule |
Rule configuration to trip the backend. |
| DataMasking |
The DataMasking. |
| DataMaskingEntity |
The DataMaskingEntity. |
| DocumentationContract |
DocumentationContract. |
| DocumentationContract.ResourceVersions |
Supported DocumentationContract resource versions. |
| EmailTemplateParametersContractProperties |
Email Template Parameter contract. |
| FailureStatusCodeRange |
The failure http status code range. |
| GatewayKeysContract |
Gateway authentication keys. |
| GroupContractProperties |
Group contract Properties. |
| HostnameConfiguration |
Custom hostname configuration. |
| HttpMessageDiagnostic |
Http message diagnostic settings. |
| KeyVaultContractCreateProperties |
Create keyVault contract details. |
| KeyVaultContractProperties |
KeyVault contract details. |
| KeyVaultLastAccessStatusContractProperties |
Issue contract Update Properties. |
| OAuth2AuthenticationSettingsContract |
API OAuth2 Authentication settings details. |
| OpenIdAuthenticationSettingsContract |
API OAuth2 Authentication settings details. |
| ParameterContract |
Operation parameters details. |
| ParameterExampleContract |
Parameter example. |
| PipelineDiagnosticSettings |
Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. |
| PolicyFragmentContract |
PolicyFragmentContract. |
| PolicyFragmentContract.ResourceVersions |
Supported PolicyFragmentContract resource versions. |
| PolicyRestrictionContract |
PolicyRestrictionContract. |
| PolicyRestrictionContract.ResourceVersions |
Supported PolicyRestrictionContract resource versions. |
| PortalConfigContract |
PortalConfigContract. |
| PortalConfigContract.ResourceVersions |
Supported PortalConfigContract resource versions. |
| PortalConfigCspProperties |
The developer portal Content Security Policy (CSP) settings. |
| PortalConfigDelegationProperties |
The PortalConfigDelegationProperties. |
| PortalConfigTermsOfServiceProperties |
Terms of service contract properties. |
| RecipientsContractProperties |
Notification Parameter contract. |
| RemotePrivateEndpointConnectionWrapper |
Remote Private Endpoint Connection resource. |
| RepresentationContract |
Operation request/response representation details. |
| RequestContract |
Operation request details. |
| ResolverContract |
ResolverContract. |
| ResolverContract.ResourceVersions |
Supported ResolverContract resource versions. |
| ResourceLocationDataContract |
Resource location data properties. |
| ResponseContract |
Operation response details. |
| SamplingSettings |
Sampling settings for Diagnostic. |
| ServiceApiResolverPolicy |
ServiceApiResolverPolicy. |
| ServiceApiResolverPolicy.ResourceVersions |
Supported ServiceApiResolverPolicy resource versions. |
| ServiceApiWiki |
ServiceApiWiki. |
| ServiceApiWiki.ResourceVersions |
Supported ServiceApiWiki resource versions. |
| ServiceProductApiLink |
ServiceProductApiLink. |
| ServiceProductApiLink.ResourceVersions |
Supported ServiceProductApiLink resource versions. |
| ServiceProductGroupLink |
ServiceProductGroupLink. |
| ServiceProductGroupLink.ResourceVersions |
Supported ServiceProductGroupLink resource versions. |
| ServiceProductWiki |
ServiceProductWiki. |
| ServiceProductWiki.ResourceVersions |
Supported ServiceProductWiki resource versions. |
| ServiceTagApiLink |
ServiceTagApiLink. |
| ServiceTagApiLink.ResourceVersions |
Supported ServiceTagApiLink resource versions. |
| ServiceTagOperationLink |
ServiceTagOperationLink. |
| ServiceTagOperationLink.ResourceVersions |
Supported ServiceTagOperationLink resource versions. |
| ServiceTagProductLink |
ServiceTagProductLink. |
| ServiceTagProductLink.ResourceVersions |
Supported ServiceTagProductLink resource versions. |
| ServiceWorkspaceApi |
ServiceWorkspaceApi. |
| ServiceWorkspaceApi.ResourceVersions |
Supported ServiceWorkspaceApi resource versions. |
| ServiceWorkspaceApiDiagnostic |
ServiceWorkspaceApiDiagnostic. |
| ServiceWorkspaceApiDiagnostic.ResourceVersions |
Supported ServiceWorkspaceApiDiagnostic resource versions. |
| ServiceWorkspaceApiOperation |
ServiceWorkspaceApiOperation. |
| ServiceWorkspaceApiOperation.ResourceVersions |
Supported ServiceWorkspaceApiOperation resource versions. |
| ServiceWorkspaceApiOperationPolicy |
ServiceWorkspaceApiOperationPolicy. |
| ServiceWorkspaceApiOperationPolicy.ResourceVersions |
Supported ServiceWorkspaceApiOperationPolicy resource versions. |
| ServiceWorkspaceApiPolicy |
ServiceWorkspaceApiPolicy. |
| ServiceWorkspaceApiPolicy.ResourceVersions |
Supported ServiceWorkspaceApiPolicy resource versions. |
| ServiceWorkspaceApiRelease |
ServiceWorkspaceApiRelease. |
| ServiceWorkspaceApiRelease.ResourceVersions |
Supported ServiceWorkspaceApiRelease resource versions. |
| ServiceWorkspaceApiSchema |
ServiceWorkspaceApiSchema. |
| ServiceWorkspaceApiSchema.ResourceVersions |
Supported ServiceWorkspaceApiSchema resource versions. |
| ServiceWorkspaceApiVersionSet |
ServiceWorkspaceApiVersionSet. |
| ServiceWorkspaceApiVersionSet.ResourceVersions |
Supported ServiceWorkspaceApiVersionSet resource versions. |
| ServiceWorkspaceBackend |
ServiceWorkspaceBackend. |
| ServiceWorkspaceBackend.ResourceVersions |
Supported ServiceWorkspaceBackend resource versions. |
| ServiceWorkspaceCertificate |
ServiceWorkspaceCertificate. |
| ServiceWorkspaceCertificate.ResourceVersions |
Supported ServiceWorkspaceCertificate resource versions. |
| ServiceWorkspaceDiagnostic |
ServiceWorkspaceDiagnostic. |
| ServiceWorkspaceDiagnostic.ResourceVersions |
Supported ServiceWorkspaceDiagnostic resource versions. |
| ServiceWorkspaceGroup |
ServiceWorkspaceGroup. |
| ServiceWorkspaceGroup.ResourceVersions |
Supported ServiceWorkspaceGroup resource versions. |
| ServiceWorkspaceLogger |
ServiceWorkspaceLogger. |
| ServiceWorkspaceLogger.ResourceVersions |
Supported ServiceWorkspaceLogger resource versions. |
| ServiceWorkspaceNamedValue |
ServiceWorkspaceNamedValue. |
| ServiceWorkspaceNamedValue.ResourceVersions |
Supported ServiceWorkspaceNamedValue resource versions. |
| ServiceWorkspaceNotification |
ServiceWorkspaceNotification. |
| ServiceWorkspaceNotification.ResourceVersions |
Supported ServiceWorkspaceNotification resource versions. |
| ServiceWorkspacePolicy |
ServiceWorkspacePolicy. |
| ServiceWorkspacePolicy.ResourceVersions |
Supported ServiceWorkspacePolicy resource versions. |
| ServiceWorkspacePolicyFragment |
ServiceWorkspacePolicyFragment. |
| ServiceWorkspacePolicyFragment.ResourceVersions |
Supported ServiceWorkspacePolicyFragment resource versions. |
| ServiceWorkspaceProduct |
ServiceWorkspaceProduct. |
| ServiceWorkspaceProduct.ResourceVersions |
Supported ServiceWorkspaceProduct resource versions. |
| ServiceWorkspaceProductApiLink |
ServiceWorkspaceProductApiLink. |
| ServiceWorkspaceProductApiLink.ResourceVersions |
Supported ServiceWorkspaceProductApiLink resource versions. |
| ServiceWorkspaceProductGroupLink |
ServiceWorkspaceProductGroupLink. |
| ServiceWorkspaceProductGroupLink.ResourceVersions |
Supported ServiceWorkspaceProductGroupLink resource versions. |
| ServiceWorkspaceProductPolicy |
ServiceWorkspaceProductPolicy. |
| ServiceWorkspaceProductPolicy.ResourceVersions |
Supported ServiceWorkspaceProductPolicy resource versions. |
| ServiceWorkspaceSchema |
ServiceWorkspaceSchema. |
| ServiceWorkspaceSchema.ResourceVersions |
Supported ServiceWorkspaceSchema resource versions. |
| ServiceWorkspaceSubscription |
ServiceWorkspaceSubscription. |
| ServiceWorkspaceSubscription.ResourceVersions |
Supported ServiceWorkspaceSubscription resource versions. |
| ServiceWorkspaceTag |
ServiceWorkspaceTag. |
| ServiceWorkspaceTag.ResourceVersions |
Supported ServiceWorkspaceTag resource versions. |
| ServiceWorkspaceTagApiLink |
ServiceWorkspaceTagApiLink. |
| ServiceWorkspaceTagApiLink.ResourceVersions |
Supported ServiceWorkspaceTagApiLink resource versions. |
| ServiceWorkspaceTagOperationLink |
ServiceWorkspaceTagOperationLink. |
| ServiceWorkspaceTagOperationLink.ResourceVersions |
Supported ServiceWorkspaceTagOperationLink resource versions. |
| ServiceWorkspaceTagProductLink |
ServiceWorkspaceTagProductLink. |
| ServiceWorkspaceTagProductLink.ResourceVersions |
Supported ServiceWorkspaceTagProductLink resource versions. |
| SubscriptionKeyParameterNamesContract |
Subscription key parameter names details. |
| TenantAccessInfo |
TenantAccessInfo. |
| TenantAccessInfo.ResourceVersions |
Supported TenantAccessInfo resource versions. |
| TermsOfServiceProperties |
Terms of service contract properties. |
| TokenBodyParameterContract |
OAuth acquire token request body parameter (www-url-form-encoded). |
| UserIdentityContract |
User identity details. |
| VirtualNetworkConfiguration |
Configuration of a virtual network to which API Management service is deployed. |
| WikiDocumentationContract |
Wiki documentation details. |
| WorkspaceContract |
WorkspaceContract. |
| WorkspaceContract.ResourceVersions |
Supported WorkspaceContract resource versions. |
| X509CertificateName |
Properties of server X509Names. |
Enums
| Name | Description |
|---|---|
| AlwaysLog |
Specifies for what type of messages sampling settings should not apply. |
| ApiGatewaySkuType |
Name of the Sku. |
| ApiManagementAuthorizationType |
Authorization type options. |
| ApiManagementGroupType |
Group type. |
| ApiManagementNatGatewayState |
Property can be used to enable NAT Gateway for this API Management service. |
| ApiManagementPrivateEndpointConnectionProvisioningState |
The current provisioning state. |
| ApiManagementPrivateEndpointServiceConnectionStatus |
The private endpoint connection status. |
| ApiManagementProductState |
whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. |
| ApiManagementServiceSkuType |
Name of the Sku. |
| ApiManagementUserState |
Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. |
| ApiOperationInvokableProtocol |
The ApiOperationInvokableProtocol. |
| ApiSchemaType |
Schema Type. Immutable. |
| ApiType |
Type of API. |
| AppType |
The AppType. |
| AuthorizationMethod |
The AuthorizationMethod. |
| BackendProtocol |
Backend communication protocol. |
| BackendType |
Type of the backend. A backend can be either Single or Pool. |
| BearerTokenSendingMethod |
The BearerTokenSendingMethod. |
| CertificateConfigurationStoreName |
The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. |
| CertificateSource |
Certificate Source. |
| CertificateStatus |
Certificate Status. |
| ClientAuthenticationMethod |
The ClientAuthenticationMethod. |
| ConfirmationEmailType |
Determines the type of confirmation e-mail that will be sent to the newly created user. |
| ContentFormat |
Format of the Content in which the API is getting imported. New formats can be added in the future. |
| DataMaskingMode |
Data masking mode. |
| DeveloperPortalStatus |
Status of developer portal in this API Management service. |
| GrantType |
The GrantType. |
| HostnameType |
Hostname type. |
| HttpCorrelationProtocol |
Sets correlation protocol to use for Application Insights diagnostics. |
| IdentityProviderType |
The IdentityProviderType. |
| IssueState |
Status of the issue. |
| LegacyApiState |
Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled'. |
| LegacyPortalStatus |
Status of legacy portal in the API Management service. |
| LoggerType |
Logger type. |
| OAuth2GrantType |
OAuth2 grant type options. |
| OperationNameFormat |
The format of the Operation Name for Application Insights telemetries. Default is Name. |
| PlatformVersion |
Compute Platform Version running the service. |
| PolicyContentFormat |
Format of the policyContent. |
| PolicyFragmentContentFormat |
The PolicyFragmentContentFormat. |
| PolicyRestrictionRequireBase |
Indicates if base policy should be enforced for the policy document. |
| PortalRevisionStatus |
Status of the portal's revision. |
| PortalSettingsCspMode |
The mode of the developer portal Content Security Policy (CSP). |
| PublicNetworkAccess |
Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'. |
| SamplingType |
Sampling type. |
| SoapApiType |
Type of API to create. *
|
| SubscriptionState |
Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. |
| TraceVerbosityLevel |
The verbosity level applied to traces emitted by trace policies. |
| TranslateRequiredQueryParametersConduct |
Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'. |
| VersioningScheme |
An value that determines where the API Version identifier will be located in a HTTP request. |
| VirtualNetworkType |
The type of VPN in which API Management gateway needs to be configured in. |
