ApiManagementServiceResource interface

Pacote:

@azure/arm-apimanagement

Um único recurso de serviço de Gerenciamento de API em Lista ou Obter resposta.

Extends

ApimResource

Propriedades

additionalLocations	Locais de datacenter adicionais do serviço de Gerenciamento de API.
apiVersionConstraint	Restrição de versão do Control Plane Apis para o serviço de Gerenciamento de API.
certificates	Lista de certificados que precisam ser instalados no serviço de Gerenciamento de API. O máximo de certificados com suporte que podem ser instalados é 10.
configurationApi	Configuração da API do serviço de Gerenciamento de API.
createdAtUtc	Data de criação utc do serviço de Gerenciamento de API. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
customProperties	Propriedades personalizadas do serviço de Gerenciamento de API. Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 desabilitará o TLS_RSA_WITH_3DES_EDE_CBC_SHA de criptografia para todos os TLS(1.0, 1.1 e 1.2). Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pode ser usado para desabilitar apenas o TLS 1.1. Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 podem ser usados para desabilitar o TLS 1.0 em um serviço de Gerenciamento de API. Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 pode ser usada para desabilitar apenas o TLS 1.1 para comunicações com back-ends. Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 podem ser usados para desabilitar o TLS 1.0 para comunicações com back-ends. Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pode ser usado para habilitar o protocolo HTTP2 em um serviço de Gerenciamento de API. Não especificar nenhuma dessas propriedades na operação PATCH redefinirá os valores das propriedades omitidas para seus padrões. Para todas as configurações, exceto Http2, o valor padrão será True se o serviço tiver sido criado em ou antes de 1º de abril de 2018 e False caso contrário. O valor padrão da configuração Http2 é False. Você pode desabilitar qualquer uma das seguintes criptografias usando configurações Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Por exemplo, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. O valor padrão é true para eles. Observação: as seguintes criptografias não podem ser desabilitadas, pois são exigidas por componentes internos da plataforma: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
developerPortalStatus	Status do portal do desenvolvedor neste serviço de Gerenciamento de API.
developerPortalUrl	URL do ponto de extremidade do Portal do DEveloper do serviço de Gerenciamento de API. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
disableGateway	Propriedade válida somente para um serviço de Gerenciamento de API implantado em vários locais. Isso pode ser usado para desabilitar o gateway na região mestra.
enableClientCertificate	Propriedade destinada apenas a ser usada para o Serviço de SKU de Consumo. Isso impõe que um certificado do cliente seja apresentado em cada solicitação ao gateway. Isso também permite a capacidade de autenticar o certificado na política no gateway.
etag	ETag do recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
gatewayRegionalUrl	URL do gateway do serviço de Gerenciamento de API na Região Padrão. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
gatewayUrl	URL do gateway do serviço de Gerenciamento de API. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
hostnameConfigurations	Configuração de nome de host personalizado do serviço de Gerenciamento de API.
identity	Identidade de serviço gerenciada do serviço de Gerenciamento de API.
legacyPortalStatus	Status do portal herdado no serviço de Gerenciamento de API.
location	Local do recurso.
managementApiUrl	URL do ponto de extremidade da API de gerenciamento do serviço de Gerenciamento de API. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
natGatewayState	A propriedade pode ser usada para habilitar o Gateway nat para este serviço de Gerenciamento de API.
notificationSenderEmail	Endereço de email do qual a notificação será enviada.
outboundPublicIPAddresses	Prefixos de endereço IPV4 públicos de saída associados ao serviço implantado do Gateway nat. Disponível apenas para SKU Premium na plataforma stv2. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
platformVersion	Versão da Plataforma de Computação executando o serviço neste local. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
portalUrl	Url do ponto de extremidade do portal do Publicador do serviço de Gerenciamento de API. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
privateEndpointConnections	Lista de conexões de ponto de extremidade privado deste serviço.
privateIPAddresses	Endereços IP de Balanceamento de Carga Estático Privado do serviço de Gerenciamento de API na região Primária, que é implantado em uma Rede Virtual Interna. Disponível apenas para SKU Básico, Standard, Premium e Isolado. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
provisioningState	O estado de provisionamento atual do serviço de Gerenciamento de API, que pode ser um dos seguintes: Criado/Ativando/Bem-sucedido/Atualizando/Falha/Parado/Terminando/Terminação Com Falha/Excluído. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
publicIPAddresses	Endereços IP com balanceamento de carga estático público do serviço de Gerenciamento de API na região primária. Disponível apenas para SKU Básico, Standard, Premium e Isolado. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
publicIpAddressId	Endereço IP baseado em IP de SKU Padrão Público V4 a ser associado ao serviço implantado da Rede Virtual na região. Com suporte apenas para desenvolvedores e SKU Premium que estão sendo implantados na Rede Virtual.
publicNetworkAccess	Se o acesso ao ponto de extremidade público é permitido ou não para esse serviço de Gerenciamento de API. O valor é opcional, mas se passado, deve ser "Habilitado" ou "Desabilitado". Se 'Disabled', pontos de extremidade privados são o método de acesso exclusivo. O valor padrão é 'Enabled'
publisherEmail	Email do publicador.
publisherName	Nome do editor.
restore	Desdelete o Serviço de Gerenciamento de API se ele foi excluído anteriormente. Se esse sinalizador for especificado e definido como True, todas as outras propriedades serão ignoradas.
scmUrl	URL do ponto de extremidade SCM do serviço de Gerenciamento de API. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
sku	Propriedades de SKU do serviço de Gerenciamento de API.
systemData	Metadados relativos à criação e última modificação do recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
targetProvisioningState	O estado de provisionamento do serviço de Gerenciamento de API, que é direcionado pela operação de execução prolongada iniciada no serviço. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
virtualNetworkConfiguration	Configuração de rede virtual do serviço de Gerenciamento de API.
virtualNetworkType	O tipo de VPN no qual o serviço de Gerenciamento de API precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço de Gerenciamento de API não faz parte de nenhuma Rede Virtual, Externo significa que a implantação de Gerenciamento de API está configurada dentro de uma Rede Virtual com um ponto de extremidade voltado para a Internet e interno significa que a implantação do Gerenciamento de API é configurada dentro de uma Rede Virtual com apenas um ponto de extremidade voltado para intranet.
zones	Uma lista de zonas de disponibilidade indicando de onde o recurso precisa vir.

Propriedades herdadas

id	ID do recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
name	Nome do recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
tags	Marcas de recurso.
type	O tipo de recurso para o recurso de Gerenciamento de API é definido como Microsoft.ApiManagement. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes da propriedade

additionalLocations

Locais de datacenter adicionais do serviço de Gerenciamento de API.

additionalLocations?: AdditionalLocation[]

Valor da propriedade

AdditionalLocation[]

apiVersionConstraint

Restrição de versão do Control Plane Apis para o serviço de Gerenciamento de API.

apiVersionConstraint?: ApiVersionConstraint

Valor da propriedade

ApiVersionConstraint

certificates

Lista de certificados que precisam ser instalados no serviço de Gerenciamento de API. O máximo de certificados com suporte que podem ser instalados é 10.

certificates?: CertificateConfiguration[]

Valor da propriedade

CertificateConfiguration[]

configurationApi

Configuração da API do serviço de Gerenciamento de API.

configurationApi?: ConfigurationApi

Valor da propriedade

ConfigurationApi

createdAtUtc

Data de criação utc do serviço de Gerenciamento de API. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

createdAtUtc?: Date

Valor da propriedade

Date

customProperties

Propriedades personalizadas do serviço de Gerenciamento de API.
Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 desabilitará o TLS_RSA_WITH_3DES_EDE_CBC_SHA de criptografia para todos os TLS(1.0, 1.1 e 1.2).
Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pode ser usado para desabilitar apenas o TLS 1.1.
Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 podem ser usados para desabilitar o TLS 1.0 em um serviço de Gerenciamento de API.
Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 pode ser usada para desabilitar apenas o TLS 1.1 para comunicações com back-ends.
Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 podem ser usados para desabilitar o TLS 1.0 para comunicações com back-ends.
Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pode ser usado para habilitar o protocolo HTTP2 em um serviço de Gerenciamento de API.
Não especificar nenhuma dessas propriedades na operação PATCH redefinirá os valores das propriedades omitidas para seus padrões. Para todas as configurações, exceto Http2, o valor padrão será True se o serviço tiver sido criado em ou antes de 1º de abril de 2018 e False caso contrário. O valor padrão da configuração Http2 é False.

Você pode desabilitar qualquer uma das seguintes criptografias usando configurações Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Por exemplo, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. O valor padrão é true para eles.
Observação: as seguintes criptografias não podem ser desabilitadas, pois são exigidas por componentes internos da plataforma: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256

customProperties?: {[propertyName: string]: string}

Valor da propriedade

{[propertyName: string]: string}

developerPortalStatus

Status do portal do desenvolvedor neste serviço de Gerenciamento de API.

developerPortalStatus?: string

Valor da propriedade

string

developerPortalUrl

URL do ponto de extremidade do Portal do DEveloper do serviço de Gerenciamento de API. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

developerPortalUrl?: string

Valor da propriedade

string

disableGateway

Propriedade válida somente para um serviço de Gerenciamento de API implantado em vários locais. Isso pode ser usado para desabilitar o gateway na região mestra.

disableGateway?: boolean

Valor da propriedade

boolean

enableClientCertificate

Propriedade destinada apenas a ser usada para o Serviço de SKU de Consumo. Isso impõe que um certificado do cliente seja apresentado em cada solicitação ao gateway. Isso também permite a capacidade de autenticar o certificado na política no gateway.

enableClientCertificate?: boolean

Valor da propriedade

boolean

etag

ETag do recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

etag?: string

Valor da propriedade

string

gatewayRegionalUrl

URL do gateway do serviço de Gerenciamento de API na Região Padrão. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

gatewayRegionalUrl?: string

Valor da propriedade

string

gatewayUrl

URL do gateway do serviço de Gerenciamento de API. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

gatewayUrl?: string

Valor da propriedade

string

hostnameConfigurations

Configuração de nome de host personalizado do serviço de Gerenciamento de API.

hostnameConfigurations?: HostnameConfiguration[]

Valor da propriedade

HostnameConfiguration[]

identity

Identidade de serviço gerenciada do serviço de Gerenciamento de API.

identity?: ApiManagementServiceIdentity

Valor da propriedade

ApiManagementServiceIdentity

legacyPortalStatus

Status do portal herdado no serviço de Gerenciamento de API.

legacyPortalStatus?: string

Valor da propriedade

string

location

Local do recurso.

location: string

Valor da propriedade

string

managementApiUrl

URL do ponto de extremidade da API de gerenciamento do serviço de Gerenciamento de API. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

managementApiUrl?: string

Valor da propriedade

string

natGatewayState

A propriedade pode ser usada para habilitar o Gateway nat para este serviço de Gerenciamento de API.

natGatewayState?: string

Valor da propriedade

string

notificationSenderEmail

Endereço de email do qual a notificação será enviada.

notificationSenderEmail?: string

Valor da propriedade

string

outboundPublicIPAddresses

Prefixos de endereço IPV4 públicos de saída associados ao serviço implantado do Gateway nat. Disponível apenas para SKU Premium na plataforma stv2. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

outboundPublicIPAddresses?: string[]

Valor da propriedade

string[]

platformVersion

Versão da Plataforma de Computação executando o serviço neste local. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

platformVersion?: string

Valor da propriedade

string

portalUrl

Url do ponto de extremidade do portal do Publicador do serviço de Gerenciamento de API. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

portalUrl?: string

Valor da propriedade

string

privateEndpointConnections

Lista de conexões de ponto de extremidade privado deste serviço.

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Valor da propriedade

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

Endereços IP de Balanceamento de Carga Estático Privado do serviço de Gerenciamento de API na região Primária, que é implantado em uma Rede Virtual Interna. Disponível apenas para SKU Básico, Standard, Premium e Isolado. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

privateIPAddresses?: string[]

Valor da propriedade

string[]

provisioningState

O estado de provisionamento atual do serviço de Gerenciamento de API, que pode ser um dos seguintes: Criado/Ativando/Bem-sucedido/Atualizando/Falha/Parado/Terminando/Terminação Com Falha/Excluído. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

provisioningState?: string

Valor da propriedade

string

publicIPAddresses

Endereços IP com balanceamento de carga estático público do serviço de Gerenciamento de API na região primária. Disponível apenas para SKU Básico, Standard, Premium e Isolado. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

publicIPAddresses?: string[]

Valor da propriedade

string[]

publicIpAddressId

Endereço IP baseado em IP de SKU Padrão Público V4 a ser associado ao serviço implantado da Rede Virtual na região. Com suporte apenas para desenvolvedores e SKU Premium que estão sendo implantados na Rede Virtual.

publicIpAddressId?: string

Valor da propriedade

string

publicNetworkAccess

Se o acesso ao ponto de extremidade público é permitido ou não para esse serviço de Gerenciamento de API. O valor é opcional, mas se passado, deve ser "Habilitado" ou "Desabilitado". Se 'Disabled', pontos de extremidade privados são o método de acesso exclusivo. O valor padrão é 'Enabled'

publicNetworkAccess?: string

Valor da propriedade

string

publisherEmail

Email do publicador.

publisherEmail: string

Valor da propriedade

string

publisherName

Nome do editor.

publisherName: string

Valor da propriedade

string

restore

Desdelete o Serviço de Gerenciamento de API se ele foi excluído anteriormente. Se esse sinalizador for especificado e definido como True, todas as outras propriedades serão ignoradas.

restore?: boolean

Valor da propriedade

boolean

scmUrl

URL do ponto de extremidade SCM do serviço de Gerenciamento de API. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

scmUrl?: string

Valor da propriedade

string

sku

Propriedades de SKU do serviço de Gerenciamento de API.

sku: ApiManagementServiceSkuProperties

Valor da propriedade

ApiManagementServiceSkuProperties

systemData

Metadados relativos à criação e última modificação do recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

systemData?: SystemData

Valor da propriedade

SystemData

targetProvisioningState

O estado de provisionamento do serviço de Gerenciamento de API, que é direcionado pela operação de execução prolongada iniciada no serviço. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

targetProvisioningState?: string

Valor da propriedade

string

virtualNetworkConfiguration

Configuração de rede virtual do serviço de Gerenciamento de API.

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Valor da propriedade

VirtualNetworkConfiguration

virtualNetworkType

O tipo de VPN no qual o serviço de Gerenciamento de API precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço de Gerenciamento de API não faz parte de nenhuma Rede Virtual, Externo significa que a implantação de Gerenciamento de API está configurada dentro de uma Rede Virtual com um ponto de extremidade voltado para a Internet e interno significa que a implantação do Gerenciamento de API é configurada dentro de uma Rede Virtual com apenas um ponto de extremidade voltado para intranet.

virtualNetworkType?: string

Valor da propriedade

string

zones

Uma lista de zonas de disponibilidade indicando de onde o recurso precisa vir.

zones?: string[]

Valor da propriedade

string[]

Detalhes das propriedades herdadas

id

ID do recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor da propriedade

string

herdado deApimResource.id

name

Nome do recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor da propriedade

string

herdado deApimResource.name

tags

Marcas de recurso.

tags?: {[propertyName: string]: string}

Valor da propriedade

{[propertyName: string]: string}

Herdado deApimResource.tags

type

O tipo de recurso para o recurso de Gerenciamento de API é definido como Microsoft.ApiManagement. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor da propriedade

string

herdado deapimResource.type