Partilhar via

ApiManagementServiceUpdateParameters interface

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

Parâmetro fornecido ao Update Api Management Service.

Extends
ApimResource

Propriedades

additionalLocations

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

Restrição de versão da Apis do Plano de Controle 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 suportados 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 pela norma ISO 8601. Observação : esta 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 desativará o TLS_RSA_WITH_3DES_EDE_CBC_SHA de codificação para todos os TLS(1.0, 1.1 e 1.2).
Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pode ser usada para desativar apenas o TLS 1.1.
Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 pode ser usada 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 desativar apenas o TLS 1.1 para comunicações com back-ends.
Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 pode ser usada para desativar o TLS 1.0 para comunicações com back-ends.
Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pode ser usada 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 é True se o serviço tiver sido criado em ou antes de 1º de abril de 2018 e False contrário. O valor padrão da configuração Http2 é False.

Você pode desativar qualquer uma das seguintes cifras 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.
Nota: As seguintes cifras não podem ser desativadas, pois são exigidas pelos 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 DEveloper do serviço de Gerenciamento de API. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
disableGateway

Propriedade válida apenas para um serviço de Gerenciamento de Api implantado em vários locais. Isso pode ser usado para desabilitar o gateway na região mestre.
enableClientCertificate

Propriedade destinada apenas a ser usada para o Serviço de SKU de Consumo. Isso impõe um certificado de cliente a ser 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 : esta 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 : esta 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 : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
hostnameConfigurations

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

Identidade de serviço gerenciado 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 : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
natGatewayState

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

Endereço de e-mail a partir do qual a notificação será enviada.
outboundPublicIPAddresses

Prefixos de endereço IPV4 público de saída associados ao serviço implantado do Gateway NAT. Disponível apenas para SKU Premium na plataforma stv2. Observação : esta 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 : esta 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 de Gerenciamento de API. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
privateEndpointConnections

Lista de Conexões de Ponto Final Privadas deste serviço.
privateIPAddresses

Endereços IP privados com balanceamento de carga estática 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 : esta 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/Falhado/Parado/Terminando/TerminaçãoFalhou/Excluído. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
publicIPAddresses

Endereços IP públicos com balanceamento de carga estática 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 : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
publicIpAddressId

Endereço IP baseado em SKU IP V4 padrão público a ser associado ao serviço implantado na Rede Virtual na região. Suportado apenas para Developer e Premium SKU sendo implantado na Rede Virtual.
publicNetworkAccess

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

E-mail do editor.
publisherName

Nome do editor.
restore

Cancele a exclusão do Serviço de Gerenciamento de Api se ele tiver sido excluído anteriormente por software. 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 : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
sku

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

O estado de provisionamento do serviço de Gerenciamento de API, que é direcionado pela operação de longa duração iniciada no serviço. Observação : esta 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 do Gerenciamento de API é 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 um Ponto de Extremidade Voltado para a Intranet apenas.
zones

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

Propriedades Herdadas

id

ID do recurso. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
name

Nome do recurso. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
tags

Tags de recursos.
type

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

Detalhes de Propriedade

additionalLocations

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

additionalLocations?: AdditionalLocation[]

Valor de Propriedade

AdditionalLocation[]

apiVersionConstraint

Restrição de versão da Apis do Plano de Controle para o serviço de Gerenciamento de API.

apiVersionConstraint?: ApiVersionConstraint

Valor de Propriedade

ApiVersionConstraint

certificates

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

certificates?: CertificateConfiguration[]

Valor de Propriedade

CertificateConfiguration[]

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 pela norma ISO 8601. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

createdAtUtc?: Date

Valor de Propriedade

Date

customProperties

Propriedades personalizadas do serviço de Gerenciamento de API.
Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 desativará o TLS_RSA_WITH_3DES_EDE_CBC_SHA de codificação para todos os TLS(1.0, 1.1 e 1.2).
Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pode ser usada para desativar apenas o TLS 1.1.
Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 pode ser usada 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 desativar apenas o TLS 1.1 para comunicações com back-ends.
Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 pode ser usada para desativar o TLS 1.0 para comunicações com back-ends.
Configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pode ser usada 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 é True se o serviço tiver sido criado em ou antes de 1º de abril de 2018 e False contrário. O valor padrão da configuração Http2 é False.

Você pode desativar qualquer uma das seguintes cifras 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.
Nota: As seguintes cifras não podem ser desativadas, pois são exigidas pelos 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 de extremidade do Portal DEveloper do serviço de Gerenciamento de API. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

developerPortalUrl?: string

Valor de Propriedade

string

disableGateway

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

disableGateway?: boolean

Valor de Propriedade

boolean

enableClientCertificate

Propriedade destinada apenas a ser usada para o Serviço de SKU de Consumo. Isso impõe um certificado de cliente a ser 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 de Propriedade

boolean

etag

ETag do recurso. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

etag?: string

Valor de Propriedade

string

gatewayRegionalUrl

URL do gateway do serviço de Gerenciamento de API na Região Padrão. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

gatewayRegionalUrl?: string

Valor de Propriedade

string

gatewayUrl

URL do gateway do serviço de Gerenciamento de API. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

gatewayUrl?: string

Valor de Propriedade

string

hostnameConfigurations

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

hostnameConfigurations?: HostnameConfiguration[]

Valor de Propriedade

HostnameConfiguration[]

identity

Identidade de serviço gerenciado do serviço de Gerenciamento de Api.

identity?: ApiManagementServiceIdentity

Valor de Propriedade

ApiManagementServiceIdentity

managementApiUrl

URL do ponto de extremidade da API de gerenciamento do serviço de gerenciamento de API. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

managementApiUrl?: string

Valor de Propriedade

string

natGatewayState

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

natGatewayState?: string

Valor de Propriedade

string

notificationSenderEmail

Endereço de e-mail a partir do qual a notificação será enviada.

notificationSenderEmail?: string

Valor de Propriedade

string

outboundPublicIPAddresses

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

outboundPublicIPAddresses?: string[]

Valor de Propriedade

string[]

platformVersion

Versão da plataforma de computação executando o serviço neste local. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

platformVersion?: string

Valor de Propriedade

string

portalUrl

URL do ponto de extremidade do portal do editor do serviço de Gerenciamento de API. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

portalUrl?: string

Valor de Propriedade

string

privateEndpointConnections

Lista de Conexões de Ponto Final Privadas deste serviço.

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Valor de Propriedade

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

Endereços IP privados com balanceamento de carga estática 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 : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

privateIPAddresses?: string[]

Valor de 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/Falhado/Parado/Terminando/TerminaçãoFalhou/Excluído. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

provisioningState?: string

Valor de Propriedade

string

publicIPAddresses

Endereços IP públicos com balanceamento de carga estática 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 : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

publicIPAddresses?: string[]

Valor de Propriedade

string[]

publicIpAddressId

Endereço IP baseado em SKU IP V4 padrão público a ser associado ao serviço implantado na Rede Virtual na região. Suportado apenas para Developer e Premium SKU sendo implantado na Rede Virtual.

publicIpAddressId?: string

Valor de Propriedade

string

publicNetworkAccess

Se o acesso ao ponto de extremidade público é permitido ou não para este serviço de Gerenciamento de API. O valor é opcional, mas se passado, deve ser 'Ativado' ou 'Desativado'. Se 'Desativado', os pontos finais privados são o método de acesso exclusivo. O valor padrão é 'Enabled'

publicNetworkAccess?: string

Valor de Propriedade

string

publisherEmail

E-mail do editor.

publisherEmail?: string

Valor de Propriedade

string

publisherName

Nome do editor.

publisherName?: string

Valor de Propriedade

string

restore

Cancele a exclusão do Serviço de Gerenciamento de Api se ele tiver sido excluído anteriormente por software. Se esse sinalizador for especificado e definido como True, todas as outras propriedades serão ignoradas.

restore?: boolean

Valor de Propriedade

boolean

scmUrl

URL do ponto de extremidade SCM do serviço de Gerenciamento de API. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

scmUrl?: string

Valor de Propriedade

string

sku

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

sku?: ApiManagementServiceSkuProperties

Valor de Propriedade

ApiManagementServiceSkuProperties

targetProvisioningState

O estado de provisionamento do serviço de Gerenciamento de API, que é direcionado pela operação de longa duração iniciada no serviço. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

targetProvisioningState?: string

Valor de Propriedade

string

virtualNetworkConfiguration

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

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Valor de 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 do Gerenciamento de API é 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 um Ponto de Extremidade Voltado para a Intranet apenas.

virtualNetworkType?: string

Valor de Propriedade

string

zones

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

zones?: string[]

Valor de Propriedade

string[]

Detalhes da Propriedade Herdada

id

ID do recurso. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor de Propriedade

string

herdada deApimResource.id

name

Nome do recurso. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor de Propriedade

string

herdada deApimResource.name

tags

Tags de recursos.

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

Valor de 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 : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor de Propriedade

string

herdado de ApimResource.type