Azure.ResourceManager.ApiManagement.Models Namespace

Classes

AdditionalLocation

Description of an additional API Management resource location.

ApiContactInformation

API contact information.

ApiCreateOrUpdateContent

Summary of revision metadata.

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiEntityBaseContract

Summary of revision metadata.

ApiIssuePatch

Issue update Parameters.

ApiLicenseInformation

API license information.

ApiManagementAuthorizationError

Authorization error details.

ApiManagementAuthorizationServerPatch

External OAuth authorization server settings.

ApiManagementBackendPatch

Backend update parameters.

ApiManagementCachePatch

Cache update details.

ApiManagementCertificateCreateOrUpdateContent

Certificate create or update details.

ApiManagementContentItem

Content type contract details.

ApiManagementContentType

Content type contract details.

ApiManagementEmailTemplateCreateOrUpdateContent

Email Template update Parameters.

ApiManagementGroupCreateOrUpdateContent

Parameters supplied to the Create Group operation.

ApiManagementGroupPatch

Parameters supplied to the Update Group operation.

ApiManagementGroupUserData

The ApiManagementGroupUserData.

ApiManagementIdentityProviderCreateOrUpdateContent

Identity Provider details.

ApiManagementIdentityProviderPatch

Parameters supplied to update Identity Provider.

ApiManagementLoggerPatch

Logger update contract.

ApiManagementNamedValueCreateOrUpdateContent

NamedValue details.

ApiManagementNamedValuePatch

NamedValue update Parameters.

ApiManagementOpenIdConnectProviderPatch

Parameters supplied to the Update OpenID Connect Provider operation.

ApiManagementPrivateEndpointConnectionCreateOrUpdateContent

A request to approve or reject a private endpoint connection.

ApiManagementPrivateLinkServiceConnectionState

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

ApiManagementProductPatch

Product Update parameters.

ApiManagementResourceSkuCapacity

Describes scaling information of a SKU.

ApiManagementServiceApplyNetworkConfigurationContent

Parameter supplied to the Apply Network configuration operation.

ApiManagementServiceBackupRestoreContent

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

ApiManagementServiceGetDomainOwnershipIdentifierResult

Response of the GetDomainOwnershipIdentifier operation.

ApiManagementServiceGetSsoTokenResult

The response of the GetSsoToken operation.

ApiManagementServiceNameAvailabilityContent

Parameters supplied to the CheckNameAvailability operation.

ApiManagementServiceNameAvailabilityResult

Response of the CheckNameAvailability operation.

ApiManagementServicePatch

Parameter supplied to Update Api Management Service.

ApiManagementServiceSkuProperties

API Management service resource SKU properties.

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

The ApiManagementSkuLocationInfo.

ApiManagementSkuRestrictionInfo

The ApiManagementSkuRestrictionInfo.

ApiManagementSkuRestrictions

Describes scaling information of a SKU.

ApiManagementSkuZoneDetails

Describes The zonal capabilities of a SKU.

ApiManagementSubscriptionCreateOrUpdateContent

Subscription create details.

ApiManagementSubscriptionPatch

Subscription update details.

ApiManagementTagCreateOrUpdateContent

Parameters supplied to Create/Update Tag operations.

ApiManagementUserCreateOrUpdateContent

User create details.

ApiManagementUserPatch

User update parameters.

ApiOperationPatch

API Operation Update Contract details.

ApiPatch

Summary of revision metadata.

ApiRevisionContract

Summary of revision metadata.

ApiTagDescriptionCreateOrUpdateContent

Parameters supplied to the Create TagDescription operation.

ApiVersionSetContractDetails

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

ApiVersionSetPatch

Parameters to update or create an API Version Set Contract.

ArmApiManagementModelFactory

Model factory for models.

AssociatedApiProperties

API contract properties for the Tag Resources.

AssociatedOperationProperties

Operation Entity contract Properties.

AssociatedProductProperties

Product profile.

AssociatedTagProperties

Contract defining the Tag property in the Tag Resource Contract.

AssociationContract

Association entity details.

AuthenticationSettingsContract

API Authentication Settings.

AuthorizationConfirmConsentCodeContent

Authorization confirm consent code request contract.

AuthorizationLoginContent

Authorization login request contract.

AuthorizationLoginResult

Authorization login response contract.

AuthorizationProviderOAuth2GrantTypes

Authorization Provider oauth2 grant types settings.

AuthorizationProviderOAuth2Settings

OAuth2 settings details.

AuthorizationServerSecretsContract

OAuth Server Secrets Contract.

AvailableApiManagementServiceSkuResult

Describes an available API Management service SKU.

BackendAuthorizationHeaderCredentials

Authorization header information.

BackendCredentialsContract

Details of the Credentials used to connect to Backend.

BackendProxyContract

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

BackendReconnectContract

Reconnect request parameters.

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.

ClientSecretContract

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

ConfigurationDeployContent

Deploy Tenant Configuration Contract.

ConfigurationSaveContent

Save Tenant Configuration Contract details.

ConnectivityCheckContent

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

ConnectivityCheckRequestDestination

The connectivity check operation destination.

ConnectivityCheckRequestHttpConfiguration

Configuration for HTTP or HTTPS requests.

ConnectivityCheckRequestSource

Definitions about the connectivity check origin.

ConnectivityCheckResult

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.

DataMasking

The DataMasking.

DataMaskingEntity

The DataMaskingEntity.

DocumentationContractPatch

Documentation update contract details.

EmailTemplateParametersContractProperties

Email Template Parameter contract.

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.

ErrorResponseBody

Error Body contract.

FailureStatusCodeRange

The failure http status code range.

GatewayApiData

Summary of revision metadata.

GatewayDebugCredentialsContract

Gateway debug credentials.

GatewayKeyRegenerateContent

Gateway key regeneration request contract properties.

GatewayKeysContract

Gateway authentication keys.

GatewayListDebugCredentialsContract

List debug credentials properties.

GatewayListTraceContract

List trace properties.

GatewayTokenContract

Gateway access token.

GatewayTokenRequestContract

Gateway token request contract properties.

GenerateSsoUriResult

Generate SSO Url operations response details.

GitOperationResultContractData

Long Running Git Operation Results.

GroupContractProperties

Group contract Properties.

HostnameConfiguration

Custom hostname configuration.

HttpHeaderConfiguration

HTTP header and it's value.

HttpMessageDiagnostic

Http message diagnostic settings.

KeyVaultContractCreateProperties

Create keyVault contract details.

KeyVaultContractProperties

KeyVault contract details.

KeyVaultLastAccessStatusContractProperties

Issue contract Update Properties.

MigrateToStv2Contract

Describes an available API Management SKU.

NamedValueSecretContract

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

NetworkStatusContract

Network Status details.

NetworkStatusContractWithLocation

Network Status in the Location.

OAuth2AuthenticationSettingsContract

API OAuth2 Authentication settings details.

OpenIdAuthenticationSettingsContract

API OAuth2 Authentication settings details.

OperationResultLogItemContract

Log of the entity being created, updated or deleted.

OutboundEnvironmentEndpoint

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

ParameterContract

Operation parameters details.

ParameterExampleContract

Parameter example.

PipelineDiagnosticSettings

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

PolicyDescriptionContractData

Policy description details.

PortalConfigCspProperties

The developer portal Content Security Policy (CSP) settings.

PortalConfigDelegationProperties

The PortalConfigDelegationProperties.

PortalConfigTermsOfServiceProperties

Terms of service contract properties.

PortalSettingsContractData

Portal Settings for the Developer Portal.

PortalSettingValidationKeyContract

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

ProductApiData

Summary of revision metadata.

ProductEntityBaseProperties

Product Entity Base Parameters.

ProductGroupData

The ProductGroupData.

QuotaCounterContract

Quota counter details.

QuotaCounterValueContractProperties

Quota counter value details.

QuotaCounterValueUpdateContent

Quota counter value details.

RecipientEmailContract

Recipient Email details.

RecipientsContractProperties

Notification Parameter contract.

RecipientUserContract

Recipient User details.

RegionContract

Region profile.

RemotePrivateEndpointConnectionWrapper

Remote Private Endpoint Connection resource.

ReportRecordContract

Report data.

RepresentationContract

Operation request/response representation details.

RequestContract

Operation request details.

RequestReportRecordContract

Request Report data.

ResolverContractPatch

GraphQL API Resolver Update Contract details.

ResourceCollectionValueItem

The ResourceCollectionValueItem.

ResourceLocationDataContract

Resource location data properties.

ResponseContract

Operation response details.

SamplingSettings

Sampling settings for Diagnostic.

SubscriptionKeyParameterNamesContract

Subscription key parameter names details.

SubscriptionKeysContract

Subscription keys.

TagResourceContractDetails

TagResource contract properties.

TenantAccessInfoCreateOrUpdateContent

Tenant access information update parameters.

TenantAccessInfoPatch

Tenant access information update parameters.

TenantAccessInfoSecretsDetails

Tenant access information contract of the API Management service.

TenantConfigurationSyncStateContract

Result of Tenant Configuration Sync State.

TermsOfServiceProperties

Terms of service contract properties.

TokenBodyParameterContract

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

UserIdentityContract

User identity details.

UserTokenContent

Get User Token parameters.

UserTokenResult

Get User Token response details.

VirtualNetworkConfiguration

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

WikiDocumentationContract

Wiki documentation details.

WikiUpdateContract

Wiki update contract details.

X509CertificateName

Properties of server X509Names.

Structs

AccessName

The AccessName.

AlwaysLog

Specifies for what type of messages sampling settings should not apply.

ApiManagementAuthorizationType

Authorization type options.

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.

ApiManagementResourceSkuCapacityScaleType

The scale type applicable to the sku.

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.

AssociationEntityProvisioningState

Provisioning state.

BackendProtocol

Backend communication protocol.

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.

ConfigurationName

The ConfigurationName.

ConfirmationEmailType

Determines the type of confirmation e-mail that will be sent to the newly created user.

ConnectionStatus

The connection status.

ConnectivityCheckProtocol

The request's protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value.

ConnectivityStatusType

Resource Connectivity Status Type identifier.

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.

GatewayListDebugCredentialsContractPurpose

Purpose of debug credential.

GrantType

The GrantType.

HostnameType

Hostname type.

HttpCorrelationProtocol

Sets correlation protocol to use for Application Insights diagnostics.

HttpMethodConfiguration

The HTTP method to be used.

IdentityProviderType

The IdentityProviderType.

IssueOrigin

The origin of the issue.

IssueSeverity

The severity of the issue.

IssueState

Status of the issue.

IssueType

The type of issue.

KeyVaultRefreshState

The KeyVaultRefreshState.

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.

MigrateToStv2Mode

Mode of Migration to stv2. Default is PreserveIp.

NotificationName

The NotificationName.

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.

PolicyExportFormat

The PolicyExportFormat.

PolicyFragmentContentFormat

The PolicyFragmentContentFormat.

PolicyName

The PolicyName.

PortalRevisionStatus

Status of the portal's revision.

PortalSettingsCspMode

The mode of the developer portal Content Security Policy (CSP).

PreferredIPVersion

The IP version to be used. Only IPv4 is supported for now.

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.

SettingsType

The SettingsType.

SoapApiType

Type of API to create.

  • http creates a REST API
  • soap creates a SOAP pass-through API
  • websocket creates websocket API
  • graphql creates GraphQL API. New types can be added in the future.
StorageAccountAccessType

The type of access to be used for the storage account.

TemplateName

The TemplateName.

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 service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.

Enums

ApiManagementGroupType

Group type.

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.

ApiManagementServiceNameUnavailableReason

Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.

ApiManagementSkuCapacityScaleType

The scale type applicable to the sku.

ApiManagementSkuRestrictionsReasonCode

The reason for restriction.

ApiManagementSkuRestrictionsType

The type of restrictions.

AsyncOperationStatus

Status of an async operation.

AuthorizationMethod

The AuthorizationMethod.

GatewayRegenerateKeyType

The Key being regenerated.

PolicyScopeContract

The PolicyScopeContract.

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.

TokenGenerationUsedKeyType

The Key to be used to generate token for user.