你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Azure.ResourceManager.ApiManagement.Models 命名空间

AdditionalLocation

其他API 管理资源位置的说明。

ApiContactInformation

API 联系人信息。

ApiCreateOrUpdateContent

API 创建或更新参数。

ApiCreateOrUpdatePropertiesWsdlSelector

将 WSDL 导入限制为文档子集的条件。

ApiEntityBaseContract

API 基本协定详细信息。

ApiIssuePatch

问题更新参数。

ApiLicenseInformation

API 许可证信息。

ApiManagementAuthorizationServerPatch

外部 OAuth 授权服务器设置。

ApiManagementBackendPatch

后端更新参数。

ApiManagementCachePatch

缓存更新详细信息。

ApiManagementCertificateCreateOrUpdateContent

证书创建或更新详细信息。

ApiManagementContentItem

内容类型协定详细信息。

ApiManagementContentType

内容类型协定详细信息。

ApiManagementEmailTemplateCreateOrUpdateContent

Email模板更新参数。

ApiManagementGroupCreateOrUpdateContent

提供给“创建组”操作的参数。

ApiManagementGroupPatch

提供给更新组操作的参数。

ApiManagementGroupUserData

ApiManagementGroupUserData。

ApiManagementIdentityProviderCreateOrUpdateContent

标识提供者详细信息。

ApiManagementIdentityProviderPatch

提供用于更新标识提供者的参数。

ApiManagementLoggerPatch

记录器更新协定。

ApiManagementNamedValueCreateOrUpdateContent

NamedValue 详细信息。

ApiManagementNamedValuePatch

NamedValue 更新参数。

ApiManagementOpenIdConnectProviderPatch

提供给更新 OpenID Connect 提供程序操作的参数。

ApiManagementPrivateEndpointConnectionCreateOrUpdateContent

批准或拒绝专用终结点连接的请求。

ApiManagementPrivateLinkServiceConnectionState

有关服务使用者和提供程序之间的连接状态的信息集合。

ApiManagementProductPatch

产品更新参数。

ApiManagementResourceSkuCapacity

描述 SKU 的缩放信息。

ApiManagementServiceApplyNetworkConfigurationContent

提供给应用网络配置操作的参数。

ApiManagementServiceBackupRestoreContent

提供给API 管理服务操作的备份/还原的参数。

ApiManagementServiceGetDomainOwnershipIdentifierResult

GetDomainOwnershipIdentifier 操作的响应。

ApiManagementServiceGetSsoTokenResult

GetSsoToken 操作的响应。

ApiManagementServiceNameAvailabilityContent

提供给 CheckNameAvailability 操作的参数。

ApiManagementServiceNameAvailabilityResult

CheckNameAvailability 操作的响应。

ApiManagementServicePatch

提供给更新 API 管理服务的参数。

ApiManagementServiceSkuProperties

API 管理服务资源 SKU 属性。

ApiManagementSku

介绍可用的 ApiManagement SKU。

ApiManagementSkuCapabilities

描述 SKU 功能对象。

ApiManagementSkuCapacity

描述 SKU 的缩放信息。

ApiManagementSkuCosts

描述用于检索价格信息的元数据。

ApiManagementSkuLocationInfo

ApiManagementSkuLocationInfo。

ApiManagementSkuRestrictionInfo

ApiManagementSkuRestrictionInfo。

ApiManagementSkuRestrictions

描述 SKU 的缩放信息。

ApiManagementSkuZoneDetails

介绍 SKU 的区域功能。

ApiManagementSubscriptionCreateOrUpdateContent

订阅创建详细信息。

ApiManagementSubscriptionPatch

订阅更新详细信息。

ApiManagementTagCreateOrUpdateContent

提供给创建/更新标记操作的参数。

ApiManagementUserCreateOrUpdateContent

用户创建详细信息。

ApiManagementUserPatch

用户更新参数。

ApiOperationPatch

API 操作更新协定详细信息。

ApiPatch

API 更新协定详细信息。

ApiRevisionContract

修订元数据摘要。

ApiTagDescriptionCreateOrUpdateContent

提供给 Create TagDescription 操作的参数。

ApiVersionSetContractDetails

API 版本集包含一组相关的 API 版本的通用配置。

ApiVersionSetPatch

用于更新或创建 API 版本集协定的参数。

ArmApiManagementModelFactory

模型的模型工厂。

AssociatedApiProperties

标记资源的 API 协定属性。

AssociatedOperationProperties

操作实体协定属性。

AssociatedProductProperties

产品配置文件。

AssociatedTagProperties

定义标记资源协定中的 Tag 属性的协定。

AssociationContract

关联实体详细信息。

AuthenticationSettingsContract

API 身份验证设置。

AuthorizationServerSecretsContract

OAuth 服务器机密协定。

AvailableApiManagementServiceSkuResult

描述可用的API 管理服务 SKU。

BackendAuthorizationHeaderCredentials

授权标头信息。

BackendCredentialsContract

用于连接到后端的凭据的详细信息。

BackendProxyContract

要用于请求后端的后端 WebProxy 服务器的详细信息。

BackendReconnectContract

重新连接请求参数。

BackendServiceFabricClusterProperties

Service Fabric 类型后端的属性。

BackendTlsProperties

控制 TLS 证书验证的属性。

CertificateConfiguration

由不受信任的中间证书和根证书组成的证书配置。

CertificateInformation

SSL 证书信息。

ClientSecretContract

IdentityProviders、Aad、OpenID 或 OAuth 中使用的客户端或应用机密。

ConfigurationDeployContent

部署租户配置协定。

ConfigurationSaveContent

保存租户配置协定详细信息。

ConnectivityCheckContent

对API 管理服务执行连接检查操作的请求。

ConnectivityCheckRequestDestination

连接检查操作目标。

ConnectivityCheckRequestHttpConfiguration

HTTP 或 HTTPS 请求的配置。

ConnectivityCheckRequestSource

有关连接检查源的定义。

ConnectivityCheckResult

有关连接状态的信息。

ConnectivityHop

有关源和目标之间的跃点的信息。

ConnectivityIssue

有关在检查连接过程中遇到的问题的信息。

ConnectivityStatusContract

有关与资源连接的详细信息。

DataMasking

DataMasking。

DataMaskingEntity

DataMaskingEntity。

EmailTemplateParametersContractProperties

Email模板参数协定。

EndpointDependency

访问服务的域名。

EndpointDetail

从 Api 管理服务到单个终结点的当前 TCP 连接信息。

ErrorFieldContract

错误字段协定。

ErrorResponseBody

错误正文协定。

GatewayApiData

GatewayApiData。

GatewayKeyRegenerateContent

网关密钥重新生成请求协定属性。

GatewayKeysContract

网关身份验证密钥。

GatewayTokenContract

网关访问令牌。

GatewayTokenRequestContract

网关令牌请求协定属性。

GenerateSsoUriResult

生成 SSO Url 操作响应详细信息。

GitOperationResultContractData

长时间运行的 Git 操作结果。

GroupContractProperties

组协定属性。

HostnameConfiguration

自定义主机名配置。

HttpHeaderConfiguration

HTTP 标头及其值。

HttpMessageDiagnostic

Http 消息诊断设置。

KeyVaultContractCreateProperties

创建 keyVault 协定详细信息。

KeyVaultContractProperties

KeyVault 合同详细信息。

KeyVaultLastAccessStatusContractProperties

发出协定更新属性。

NamedValueSecretContract

IdentityProviders、Aad、OpenID 或 OAuth 中使用的客户端或应用机密。

NetworkStatusContract

网络状态详细信息。

NetworkStatusContractWithLocation

“位置”中的“网络状态”。

OAuth2AuthenticationSettingsContract

API OAuth2 身份验证设置详细信息。

OpenIdAuthenticationSettingsContract

API OAuth2 身份验证设置详细信息。

OperationResultLogItemContract

正在创建、更新或删除的实体的日志。

OutboundEnvironmentEndpoint

出于 Api 管理服务需要出站网络访问权限的常见目的访问的终结点。

ParameterContract

操作参数详细信息。

ParameterExampleContract

参数示例。

PipelineDiagnosticSettings

传入/传出 HTTP 消息到网关的诊断设置。

PolicyDescriptionContractData

策略说明详细信息。

PortalSettingsContractData

开发人员门户的门户设置。

PortalSettingValidationKeyContract

IdentityProviders、Aad、OpenID 或 OAuth 中使用的客户端或应用机密。

ProductApiData

ProductApiData。

ProductEntityBaseProperties

产品实体基参数。

ProductGroupData

ProductGroupData。

QuotaCounterContract

配额计数器详细信息。

QuotaCounterValueContractProperties

配额计数器值详细信息。

QuotaCounterValueUpdateContent

配额计数器值详细信息。

RecipientEmailContract

收件人Email详细信息。

RecipientsContractProperties

通知参数协定。

RecipientUserContract

收件人用户详细信息。

RegionContract

区域配置文件。

RemotePrivateEndpointConnectionWrapper

远程专用终结点连接资源。

ReportRecordContract

报表数据。

RepresentationContract

操作请求/响应表示形式详细信息。

RequestContract

操作请求详细信息。

RequestReportRecordContract

请求报表数据。

ResourceLocationDataContract

资源位置数据属性。

ResponseContract

操作响应详细信息。

SamplingSettings

诊断的采样设置。

SubscriptionKeyParameterNamesContract

订阅密钥参数名称详细信息。

SubscriptionKeysContract

订阅密钥。

TagResourceContractDetails

TagResource 协定属性。

TenantAccessInfoCreateOrUpdateContent

租户访问信息更新参数。

TenantAccessInfoPatch

租户访问信息更新参数。

TenantAccessInfoSecretsDetails

API 管理服务的租户访问信息协定。

TenantConfigurationSyncStateContract

租户配置同步状态的结果。

TermsOfServiceProperties

服务条款协定属性。

TokenBodyParameterContract

OAuth 获取令牌请求正文参数 (www-url-form-encoded) 。

UserIdentityContract

用户标识详细信息。

UserTokenContent

获取用户令牌参数。

UserTokenResult

获取用户令牌响应详细信息。

VirtualNetworkConfiguration

API 管理服务部署到的虚拟网络的配置。

X509CertificateName

服务器 X509Names 的属性。

结构

AccessName

AccessName。

AlwaysLog

指定不应应用哪种类型的消息采样设置。

ApiManagementPrivateEndpointConnectionProvisioningState

当前预配状态。

ApiManagementPrivateEndpointServiceConnectionStatus

专用终结点连接状态。

ApiManagementResourceSkuCapacityScaleType

适用于 SKU 的缩放类型。

ApiManagementServiceSkuType

SKU 的名称。

ApiManagementUserState

帐户状态。 指定用户是否处于活动状态。 被阻止的用户无法登录开发人员门户或调用已订阅产品的任何 API。 默认状态为“活动”。

ApiOperationInvokableProtocol

ApiOperationInvokableProtocol。

ApiSchemaType

架构类型。 不可变。

ApiType

API 的类型。

AppType

AppType。

AssociationEntityProvisioningState

预配状态。

BackendProtocol

后端通信协议。

BearerTokenSendingMethod

BearerTokenSendingMethod。

CertificateConfigurationStoreName

System.Security.Cryptography.x509certificates.StoreName 证书存储位置。 只有 Root 和 CertificateAuthority 是有效位置。

CertificateSource

证书源。

CertificateStatus

证书状态。

ClientAuthenticationMethod

ClientAuthenticationMethod。

ConfigurationName

ConfigurationName。

ConfirmationEmailType

确定将发送给新创建的用户的确认电子邮件的类型。

ConnectionStatus

连接状态。

ConnectivityCheckProtocol

请求的协议。 可以根据此选择提供特定的协议配置。 指定的目标地址必须与此值一致。

ConnectivityStatusType

资源连接状态类型标识符。

ContentFormat

要导入 API 的内容的格式。

DataMaskingMode

数据掩码模式。

GrantType

GrantType。

HostnameType

主机名类型。

HttpCorrelationProtocol

设置要用于 Application Insights 诊断的相关协议。

HttpMethodConfiguration

要使用的 HTTP 方法。

IdentityProviderType

IdentityProviderType。

IssueOrigin

问题的来源。

IssueSeverity

问题的严重性。

IssueState

问题的状态。

IssueType

问题的类型。

LoggerType

记录器类型。

NotificationName

NotificationName。

OperationNameFormat

Application Insights 遥测的操作名称的格式。 默认值为 Name。

PlatformVersion

运行服务的计算平台版本。

PolicyContentFormat

policyContent 的格式。

PolicyExportFormat

PolicyExportFormat。

PolicyName

PolicyName。

PortalRevisionStatus

门户修订的状态。

PreferredIPVersion

要使用的 IP 版本。 目前仅支持 IPv4。

PublicNetworkAccess

此API 管理服务是否允许公共终结点访问。 值是可选的,但如果传入,则必须为“Enabled”或“Disabled”。 如果为“Disabled”,则专用终结点是独占访问方法。 默认值为“Enabled”。

SamplingType

采样类型。

SettingsType

SettingsType。

SoapApiType

要创建的 API 的类型。

  • http 创建 REST API
  • soap 创建 SOAP 传递 API
  • websocket 创建 websocket API
  • graphql创建 GraphQL API。
StorageAccountAccessType

要用于存储帐户的访问类型。

TemplateName

TemplateName。

TraceVerbosityLevel

应用于跟踪策略发出的跟踪的详细级别。

VersioningScheme

一个 值,该值确定 API 版本标识符在 HTTP 请求中的位置。

VirtualNetworkType

需要在其中配置API 管理服务的 VPN 类型。 无 (默认值) 表示API 管理服务不属于任何虚拟网络,外部表示API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的,而“内部”表示API 管理部署是在仅具有面向 Intranet 的终结点的虚拟网络内设置的.

枚举

ApiManagementGroupType

组类型。

ApiManagementProductState

是否发布产品。 开发人员门户的用户可发现已发布的产品。 未发布的产品仅对管理员可见。 产品的默认状态为 NotPublished。

ApiManagementServiceNameUnavailableReason

无效表示提供的名称与资源提供程序的命名要求不匹配 (长度不正确、字符不受支持等。) AlreadyExists 指示该名称已在使用中,因此不可用。

ApiManagementSkuCapacityScaleType

适用于 SKU 的缩放类型。

ApiManagementSkuRestrictionsReasonCode

限制的原因。

ApiManagementSkuRestrictionsType

限制的类型。

AsyncOperationStatus

异步操作的状态。

AuthorizationMethod

AuthorizationMethod。

GatewayRegenerateKeyType

正在重新生成的密钥。

PolicyScopeContract

PolicyScopeContract。

SubscriptionState

订阅状态。 可能的状态为 * 活动 - 订阅处于活动状态,* 已暂停 - 订阅被阻止,订阅者无法调用产品的任何 API,* 已提交 - 订阅请求已由开发人员提出,但尚未批准或拒绝,* 已拒绝 - 订阅请求已被管理员拒绝,* 已取消 - 开发人员或管理员已取消订阅, * 已过期 – 订阅已过期并已停用。

TokenGenerationUsedKeyType

用于为用户生成令牌的密钥。