Partilhar via

ApiManagementServiceBaseProperties interface

  • Referência
Pacote:
@azure/arm-apimanagement

Propriedades Base de uma descrição do recurso do serviço Gestão de API.

Propriedades

additionalLocations

Localizações adicionais do datacenter do serviço Gestão de API.
apiVersionConstraint

Restrição da versão das Apis do Plano de Controlo para o serviço de Gestão de API.
certificates

Lista de Certificados que precisam de ser instalados no serviço Gestão de API. O máximo de certificados suportados que podem ser instalados é 10.
createdAtUtc

Data UTC de criação do serviço Gestão de API. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
customProperties

Propriedades personalizadas do serviço Gestão de API.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 irá desativar a cifra TLS_RSA_WITH_3DES_EDE_CBC_SHA para todos os TLS(1.0, 1.1 e 1.2).
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pode ser utilizada para desativar apenas o TLS 1.1.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 pode ser utilizada para desativar o TLS 1.0 num serviço Gestão de API.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 pode ser utilizada para desativar apenas o TLS 1.1 para comunicações com back-ends.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 pode ser utilizada para desativar o TLS 1.0 para comunicações com back-ends.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pode ser utilizada para ativar o protocolo HTTP2 num serviço Gestão de API.
Não especificar nenhuma destas propriedades na operação PATCH irá repor os valores das propriedades omitidas para as respetivas predefinições. Para todas as definições exceto Http2, o valor predefinido é True se o serviço foi criado em ou antes de 1 de abril de 2018 e False de outra forma. O valor predefinido da definição http2 é False.

Pode desativar qualquer uma das seguintes cifras com as definiçõ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 predefinido é true para eles.
Nota: as seguintes cifras não podem ser desativadas, uma vez que são necessárias 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
developerPortalUrl

URL do ponto final do portal do DEveloper do serviço Gestão de API. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
disableGateway

Propriedade válida apenas para um serviço de Gestão de API implementado em várias localizações. Isto pode ser utilizado para desativar o gateway na região mestra.
enableClientCertificate

Propriedade destinada apenas a ser utilizada para o Serviço SKU de Consumo. Isto impõe a apresentação de um certificado de cliente em cada pedido ao gateway. Isto também permite a capacidade de autenticar o certificado na política no gateway.
gatewayRegionalUrl

URL do gateway do serviço Gestão de API na Região Predefinida. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
gatewayUrl

URL do gateway do serviço Gestão de API. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
hostnameConfigurations

Configuração personalizada do nome do anfitrião do serviço Gestão de API.
managementApiUrl

URL do ponto final da API de Gestão do serviço Gestão de API. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
natGatewayState

A propriedade pode ser utilizada para ativar o NAT Gateway para este serviço de Gestão de API.
notificationSenderEmail

Email endereço a partir do qual a notificação será enviada.
outboundPublicIPAddresses

Prefixos de endereço IPV4 públicos de saída associados ao serviço implementado do NAT Gateway. Disponível apenas para SKU Premium na plataforma stv2. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
platformVersion

Versão da Plataforma de Computação a executar o serviço nesta localização. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
portalUrl

Url do ponto final do portal do Publisher do serviço Gestão de API. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
privateEndpointConnections

Lista de Ligações de Ponto Final Privado deste serviço.
privateIPAddresses

Endereços IP com Balanceamento de Carga Estática Privada do serviço de Gestão de API na região Primária que é implementado numa Rede Virtual Interna. Disponível apenas para SKU Básico, Standard, Premium e Isolado. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
provisioningState

O estado de aprovisionamento atual do serviço Gestão de API, que pode ser um dos seguintes: Criado/Ativar/Com Êxito/Atualização/Falhado/Parado/Terminação/Terminação Falhou/Eliminado. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
publicIPAddresses

Endereços IP com Balanceamento de Carga Estático Público do serviço Gestão de API na região Primária. Disponível apenas para SKU Básico, Standard, Premium e Isolado. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
publicIpAddressId

Endereço IP V4 baseado em IP do SKU Standard Público a ser associado a Rede Virtual serviço implementado na região. Suportada apenas para o Programador e o SKU Premium que está a ser implementado no Rede Virtual.
publicNetworkAccess

Se o acesso ao ponto final público é ou não permitido para este serviço de Gestão de API. O valor é opcional, mas, se for transmitido, tem de ser "Ativado" ou "Desativado". Se "Desativado", os pontos finais privados são o método de acesso exclusivo. O valor predefinido é "Ativado"
restore

Anular a eliminação do Serviço de Gestão de API se tiver sido eliminado de forma recuperável anteriormente. Se este sinalizador for especificado e definido como Verdadeiro, todas as outras propriedades serão ignoradas.
scmUrl

URL do ponto final SCM do serviço Gestão de API. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
targetProvisioningState

O estado de aprovisionamento do serviço Gestão de API, que é visado pela operação de execução prolongada iniciada no serviço. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
virtualNetworkConfiguration

Configuração da rede virtual do serviço Gestão de API.
virtualNetworkType

O tipo de VPN na qual Gestão de API serviço tem de ser configurado. Nenhum (Valor Predefinido) significa que o serviço Gestão de API não faz parte de nenhuma Rede Virtual, Externo significa que a implementação Gestão de API está configurada num Rede Virtual ter um Ponto Final Com Acesso à Internet e Interno significa que Gestão de API implementação está configurada dentro de um Rede Virtual ter apenas um Ponto Final Com Acesso à Intranet.

Detalhes de Propriedade

additionalLocations

Localizações adicionais do datacenter do serviço Gestão de API.

additionalLocations?: AdditionalLocation[]

Valor de Propriedade

AdditionalLocation[]

apiVersionConstraint

Restrição da versão das Apis do Plano de Controlo para o serviço de Gestão de API.

apiVersionConstraint?: ApiVersionConstraint

Valor de Propriedade

ApiVersionConstraint

certificates

Lista de Certificados que precisam de ser instalados no serviço Gestão de API. O máximo de certificados suportados que podem ser instalados é 10.

certificates?: CertificateConfiguration[]

Valor de Propriedade

CertificateConfiguration[]

createdAtUtc

Data UTC de criação do serviço Gestão de API. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pela norma ISO 8601. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

createdAtUtc?: Date

Valor de Propriedade

Date

customProperties

Propriedades personalizadas do serviço Gestão de API.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 irá desativar a cifra TLS_RSA_WITH_3DES_EDE_CBC_SHA para todos os TLS(1.0, 1.1 e 1.2).
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pode ser utilizada para desativar apenas o TLS 1.1.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 pode ser utilizada para desativar o TLS 1.0 num serviço Gestão de API.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 pode ser utilizada para desativar apenas o TLS 1.1 para comunicações com back-ends.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 pode ser utilizada para desativar o TLS 1.0 para comunicações com back-ends.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pode ser utilizada para ativar o protocolo HTTP2 num serviço Gestão de API.
Não especificar nenhuma destas propriedades na operação PATCH irá repor os valores das propriedades omitidas para as respetivas predefinições. Para todas as definições exceto Http2, o valor predefinido é True se o serviço foi criado em ou antes de 1 de abril de 2018 e False de outra forma. O valor predefinido da definição http2 é False.

Pode desativar qualquer uma das seguintes cifras com as definiçõ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 predefinido é true para eles.
Nota: as seguintes cifras não podem ser desativadas, uma vez que são necessárias 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 de Propriedade

{[propertyName: string]: string}

developerPortalUrl

URL do ponto final do portal do DEveloper do serviço Gestão de API. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

developerPortalUrl?: string

Valor de Propriedade

string

disableGateway

Propriedade válida apenas para um serviço de Gestão de API implementado em várias localizações. Isto pode ser utilizado para desativar o gateway na região mestra.

disableGateway?: boolean

Valor de Propriedade

boolean

enableClientCertificate

Propriedade destinada apenas a ser utilizada para o Serviço SKU de Consumo. Isto impõe a apresentação de um certificado de cliente em cada pedido ao gateway. Isto também permite a capacidade de autenticar o certificado na política no gateway.

enableClientCertificate?: boolean

Valor de Propriedade

boolean

gatewayRegionalUrl

URL do gateway do serviço Gestão de API na Região Predefinida. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

gatewayRegionalUrl?: string

Valor de Propriedade

string

gatewayUrl

URL do gateway do serviço Gestão de API. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

gatewayUrl?: string

Valor de Propriedade

string

hostnameConfigurations

Configuração personalizada do nome do anfitrião do serviço Gestão de API.

hostnameConfigurations?: HostnameConfiguration[]

Valor de Propriedade

HostnameConfiguration[]

managementApiUrl

URL do ponto final da API de Gestão do serviço Gestão de API. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

managementApiUrl?: string

Valor de Propriedade

string

natGatewayState

A propriedade pode ser utilizada para ativar o NAT Gateway para este serviço de Gestão de API.

natGatewayState?: string

Valor de Propriedade

string

notificationSenderEmail

Email endereço a partir do qual a notificação será enviada.

notificationSenderEmail?: string

Valor de Propriedade

string

outboundPublicIPAddresses

Prefixos de endereço IPV4 públicos de saída associados ao serviço implementado do NAT Gateway. Disponível apenas para SKU Premium na plataforma stv2. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

outboundPublicIPAddresses?: string[]

Valor de Propriedade

string[]

platformVersion

Versão da Plataforma de Computação a executar o serviço nesta localização. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

platformVersion?: string

Valor de Propriedade

string

portalUrl

Url do ponto final do portal do Publisher do serviço Gestão de API. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

portalUrl?: string

Valor de Propriedade

string

privateEndpointConnections

Lista de Ligações de Ponto Final Privado deste serviço.

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Valor de Propriedade

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

Endereços IP com Balanceamento de Carga Estática Privada do serviço de Gestão de API na região Primária que é implementado numa Rede Virtual Interna. Disponível apenas para SKU Básico, Standard, Premium e Isolado. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

privateIPAddresses?: string[]

Valor de Propriedade

string[]

provisioningState

O estado de aprovisionamento atual do serviço Gestão de API, que pode ser um dos seguintes: Criado/Ativar/Com Êxito/Atualização/Falhado/Parado/Terminação/Terminação Falhou/Eliminado. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

provisioningState?: string

Valor de Propriedade

string

publicIPAddresses

Endereços IP com Balanceamento de Carga Estático Público do serviço Gestão de API na região Primária. Disponível apenas para SKU Básico, Standard, Premium e Isolado. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

publicIPAddresses?: string[]

Valor de Propriedade

string[]

publicIpAddressId

Endereço IP V4 baseado em IP do SKU Standard Público a ser associado a Rede Virtual serviço implementado na região. Suportada apenas para o Programador e o SKU Premium que está a ser implementado no Rede Virtual.

publicIpAddressId?: string

Valor de Propriedade

string

publicNetworkAccess

Se o acesso ao ponto final público é ou não permitido para este serviço de Gestão de API. O valor é opcional, mas, se for transmitido, tem de ser "Ativado" ou "Desativado". Se "Desativado", os pontos finais privados são o método de acesso exclusivo. O valor predefinido é "Ativado"

publicNetworkAccess?: string

Valor de Propriedade

string

restore

Anular a eliminação do Serviço de Gestão de API se tiver sido eliminado de forma recuperável anteriormente. Se este sinalizador for especificado e definido como Verdadeiro, todas as outras propriedades serão ignoradas.

restore?: boolean

Valor de Propriedade

boolean

scmUrl

URL do ponto final SCM do serviço Gestão de API. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

scmUrl?: string

Valor de Propriedade

string

targetProvisioningState

O estado de aprovisionamento do serviço Gestão de API, que é visado pela operação de execução prolongada iniciada no serviço. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.

targetProvisioningState?: string

Valor de Propriedade

string

virtualNetworkConfiguration

Configuração da rede virtual do serviço Gestão de API.

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Valor de Propriedade

VirtualNetworkConfiguration

virtualNetworkType

O tipo de VPN na qual Gestão de API serviço tem de ser configurado. Nenhum (Valor Predefinido) significa que o serviço Gestão de API não faz parte de nenhuma Rede Virtual, Externo significa que a implementação Gestão de API está configurada num Rede Virtual ter um Ponto Final Com Acesso à Internet e Interno significa que Gestão de API implementação está configurada dentro de um Rede Virtual ter apenas um Ponto Final Com Acesso à Intranet.

virtualNetworkType?: string

Valor de Propriedade

string