Compartilhar via

ApiManagementServiceProperties interface

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

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

Extends
ApiManagementServiceBaseProperties

Propriedades

publisherEmail

Email do publicador.
publisherName

Nome do editor.

Propriedades herdadas

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.
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
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.
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.
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'
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.
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.

Detalhes da propriedade

publisherEmail

Email do publicador.

publisherEmail: string

Valor da propriedade

string

publisherName

Nome do editor.

publisherName: string

Valor da propriedade

string

Detalhes das propriedades herdadas

additionalLocations

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

additionalLocations?: AdditionalLocation[]

Valor da propriedade

AdditionalLocation[]

herdado deApiManagementServiceBaseProperties.additionalLocations

apiVersionConstraint

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

apiVersionConstraint?: ApiVersionConstraint

Valor da propriedade

ApiVersionConstraint

herdado deApiManagementServiceBaseProperties.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[]

herdado de ApiManagementServiceBaseProperties.certificates

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

herdado deApiManagementServiceBaseProperties.createdAtUtc

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}

herdado deApiManagementServiceBaseProperties.customProperties

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

herdado deApiManagementServiceBaseProperties.developerPortalUrl

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

herdado deApiManagementServiceBaseProperties.disableGateway

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

herdado deApiManagementServiceBaseProperties.enableClientCertificate

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

herdado de ApiManagementServiceBaseProperties.gatewayRegionalUrl

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

herdado deApiManagementServiceBaseProperties.gatewayUrl

hostnameConfigurations

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

hostnameConfigurations?: HostnameConfiguration[]

Valor da propriedade

HostnameConfiguration[]

Herdado deApiManagementServiceBaseProperties.hostnameConfigurations

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

herdado de ApiManagementServiceBaseProperties.managementApiUrl

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

herdado deApiManagementServiceBaseProperties.natGatewayState

notificationSenderEmail

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

notificationSenderEmail?: string

Valor da propriedade

string

herdado de ApiManagementServiceBaseProperties.notificationSenderEmail

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[]

herdado deApiManagementServiceBaseProperties.outboundPublicIPAddresses

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

herdado deApiManagementServiceBaseProperties.platformVersion

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

herdado deApiManagementServiceBaseProperties.portalUrl

privateEndpointConnections

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

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Valor da propriedade

RemotePrivateEndpointConnectionWrapper[]

herdado deApiManagementServiceBaseProperties.privateEndpointConnections

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[]

herdado deApiManagementServiceBaseProperties.privateIPAddresses

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

herdado deApiManagementServiceBaseProperties.provisioningState

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[]

herdado deApiManagementServiceBaseProperties.publicIPAddresses

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

herdado deApiManagementServiceBaseProperties.publicIpAddressId

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

herdado deApiManagementServiceBaseProperties.publicNetworkAccess

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

herdado deApiManagementServiceBaseProperties.restore

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

herdado de ApiManagementServiceBaseProperties.scmUrl

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

herdado deApiManagementServiceBaseProperties.targetProvisioningState

virtualNetworkConfiguration

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

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Valor da propriedade

VirtualNetworkConfiguration

herdado deApiManagementServiceBaseProperties.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

herdado de ApiManagementServiceBaseProperties.virtualNetworkType