Compartilhar via

ApiManagementServiceResource interface

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

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

Extends
ApimResource

Propriedades

additionalLocations

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

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

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

Data utc de criação do serviço 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 Gerenciamento de API.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 desabilitará a TLS_RSA_WITH_3DES_EDE_CBC_SHA de criptografia para todos os TLS(1.0, 1.1 e 1.2).
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pode ser usada para desabilitar apenas o TLS 1.1.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 pode ser usada para desabilitar o TLS 1.0 em um serviço Gerenciamento de API.
A 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.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 pode ser usada para desabilitar o TLS 1.0 para comunicações com back-ends.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pode ser usada para habilitar o protocolo HTTP2 em um serviço 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 de outra forma. O valor padrão da configuração http2 é False.

Você pode desabilitar qualquer uma das seguintes codificações usando as 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 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 em master região.
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 para o 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 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 Gerenciamento de API.
identity

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

Local do recurso.
managementApiUrl

URL do ponto de extremidade da API de gerenciamento do serviço 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 da NAT para esse serviço de Gerenciamento de API.
notificationSenderEmail

Email endereço 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 da 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 editor do serviço 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 desse serviço.
privateIPAddresses

Endereços IP com balanceamento de carga estático privado do serviço 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/Com Falha/Parado/Encerrando/Terminando Com Falha/Excluído. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
publicIPAddresses

Endereços IP de balanceamento de carga estáticos públicos do serviço 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 a Rede Virtual serviço implantado na região. Compatível apenas com o SKU Premium e desenvolvedor que está sendo implantado no Rede Virtual.
publicNetworkAccess

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

Email do publicador.
publisherName

Nome do publicador.
restore

Desmarque o Serviço de Gerenciamento de API se ele tiver sido 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 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 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 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 Gerenciamento de API.
virtualNetworkType

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

Uma lista de zonas de disponibilidade que indica 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 Gerenciamento de API recurso é 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 Gerenciamento de API.

additionalLocations?: AdditionalLocation[]

Valor da propriedade

AdditionalLocation[]

apiVersionConstraint

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

apiVersionConstraint?: ApiVersionConstraint

Valor da propriedade

ApiVersionConstraint

certificates

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

certificates?: CertificateConfiguration[]

Valor da propriedade

CertificateConfiguration[]

createdAtUtc

Data utc de criação do serviço 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 Gerenciamento de API.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 desabilitará a TLS_RSA_WITH_3DES_EDE_CBC_SHA de criptografia para todos os TLS(1.0, 1.1 e 1.2).
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pode ser usada para desabilitar apenas o TLS 1.1.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 pode ser usada para desabilitar o TLS 1.0 em um serviço Gerenciamento de API.
A 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.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 pode ser usada para desabilitar o TLS 1.0 para comunicações com back-ends.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pode ser usada para habilitar o protocolo HTTP2 em um serviço 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 de outra forma. O valor padrão da configuração http2 é False.

Você pode desabilitar qualquer uma das seguintes codificações usando as 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}

developerPortalUrl

URL do ponto de extremidade do Portal do DEveloper do serviço 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 em master região.

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 para o 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 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 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

location

Local do recurso.

location: string

Valor da propriedade

string

managementApiUrl

URL do ponto de extremidade da API de gerenciamento do serviço 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 da NAT para esse serviço de Gerenciamento de API.

natGatewayState?: string

Valor da propriedade

string

notificationSenderEmail

Email endereço 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 da 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 editor do serviço 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 desse serviço.

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Valor da propriedade

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

Endereços IP com balanceamento de carga estático privado do serviço 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/Com Falha/Parado/Encerrando/Terminando 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 de balanceamento de carga estáticos públicos do serviço 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 a Rede Virtual serviço implantado na região. Compatível apenas com o SKU Premium e desenvolvedor que está sendo implantado no 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 Gerenciamento de API. O valor é opcional, mas, se passado, deve ser "Habilitado" ou "Desabilitado". Se 'Desabilitado', os pontos de extremidade privados serã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 publicador.

publisherName: string

Valor da propriedade

string

restore

Desmarque o Serviço de Gerenciamento de API se ele tiver sido 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 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 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 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 Gerenciamento de API.

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Valor da propriedade

VirtualNetworkConfiguration

virtualNetworkType

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

virtualNetworkType?: string

Valor da propriedade

string

zones

Uma lista de zonas de disponibilidade que indica 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 Gerenciamento de API recurso é 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