Sdílet prostřednictvím

ApiManagementServiceUpdateParameters interface

  • Reference
Balíček:
@azure/arm-apimanagement

Parametr zadaný službou Update Api Management

Extends
ApimResource

Vlastnosti

additionalLocations

Další umístění datacenter služby API Management
apiVersionConstraint

Omezení verze APIS roviny řízení pro službu API Management
certificates

Seznam certifikátů, které je potřeba nainstalovat ve službě API Management Maximální počet podporovaných certifikátů, které je možné nainstalovat, je 10.
createdAtUtc

Datum vytvoření utc služby API Management Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
customProperties

Vlastní vlastnosti služby API Management
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 zakáže TLS_RSA_WITH_3DES_EDE_CBC_SHA šifry pro všechny protokoly TLS(1.0, 1.1 a 1.2).
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 lze použít k zakázání pouze protokolu TLS 1.1.
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 lze použít k zakázání protokolu TLS 1.0 ve službě API Management.
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 lze použít k zakázání pouze protokolu TLS 1.1 pro komunikaci s back-endy.
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 lze použít k zakázání protokolu TLS 1.0 pro komunikaci s back-endy.
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 lze použít k povolení protokolu HTTP2 ve službě API Management.
Nezadání žádné z těchto vlastností v operaci PATCH resetuje hodnoty vynechaných vlastností na výchozí hodnoty. Pro všechna nastavení kromě Http2 je výchozí hodnota True, pokud byla služba vytvořena 1. dubna 2018 a False jinak. Výchozí hodnota nastavení Http2 je False.

Pomocí Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]nastavení můžete zakázat některou z následujících šifer: 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. Například Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Výchozí hodnota je true pro ně.
Poznámka: Následující šifry nelze zakázat, protože jsou vyžadovány interními komponentami platformy: 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

Adresa URL koncového bodu portálu DEveloper služby API Management POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
disableGateway

Vlastnost platí pouze pro službu Api Management nasazenou ve více umístěních. To se dá použít k zakázání brány v hlavní oblasti.
enableClientCertificate

Vlastnost má být použita pouze pro službu SKU Consumption. To vynucuje, aby se klientský certifikát zobrazoval na každém požadavku bráně. To také umožňuje ověřit certifikát v zásadách brány.
etag

ETag prostředku. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
gatewayRegionalUrl

Adresa URL brány služby API Management ve výchozí oblasti POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
gatewayUrl

Adresa URL brány služby API Management POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
hostnameConfigurations

Vlastní konfigurace názvu hostitele služby API Management
identity

Identita spravované služby služby Api Management
managementApiUrl

Adresa URL koncového bodu rozhraní API pro správu služby API Management POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
natGatewayState

Vlastnost se dá použít k povolení služby NAT Gateway pro tuto službu API Management.
notificationSenderEmail

E-mailová adresa, ze které se oznámení odešle.
outboundPublicIPAddresses

Odchozí předpony veřejných IPV4 adres přidružených k nasazené službě NAT Gateway K dispozici pouze pro skladovou položku Premium na platformě stv2. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
platformVersion

Verze výpočetní platformy, na které běží služba v tomto umístění. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
portalUrl

Adresa URL koncového bodu portálu vydavatele služby API Management POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
privateEndpointConnections

Seznam připojení privátních koncových bodů této služby
privateIPAddresses

Privátní IP adresy služby API Management s vyrovnáváním zatížení v primární oblasti, která je nasazená v interní virtuální síti. K dispozici pouze pro SKU Basic, Standard, Premium a Isolated. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
provisioningState

Aktuální stav zřizování služby API Management, který může být jedním z následujících způsobů: Vytvoření, aktivace, úspěch, aktualizace, selhání, ukončení, ukončení nebo odstranění. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
publicIPAddresses

Veřejné IP adresy služby API Management se statickým vyrovnáváním zatížení v primární oblasti K dispozici pouze pro SKU Basic, Standard, Premium a Isolated. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
publicIpAddressId

IP adresa založená na veřejné standardní SKU V4, která se má přidružit k nasazené službě virtuální sítě v dané oblasti. Podporuje se jenom pro SKU Pro vývojáře a Premium nasazené ve virtuální síti.
publicNetworkAccess

Určuje, jestli je pro tuto službu API Management povolený přístup k veřejnému koncovému bodu. Hodnota je nepovinná, ale pokud je předaná, musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, privátní koncové body jsou výhradní metodou přístupu. Výchozí hodnota je Enabled
publisherEmail

E-mail vydavatele.
publisherName

Název vydavatele.
restore

Pokud byla dříve obnovitelně odstraněna, zrušte odstranění služby Api Management. Pokud je tento příznak zadaný a nastaví se na Hodnotu True, budou ignorovány všechny ostatní vlastnosti.
scmUrl

Adresa URL koncového bodu SCM služby API Management POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
sku

Vlastnosti skladové položky služby API Management
targetProvisioningState

Stav zřizování služby API Management, na který cílí dlouhotrvající operace spuštěná ve službě. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
virtualNetworkConfiguration

Konfigurace virtuální sítě služby API Management
virtualNetworkType

Typ sítě VPN, ve které je potřeba nakonfigurovat službu API Management. Žádná (výchozí hodnota) znamená, že služba API Management není součástí žádné virtuální sítě, externí znamená, že nasazení služby API Management je nastavené uvnitř virtuální sítě s internetovým koncovým bodem a interní znamená, že nasazení služby API Management je nastaveno uvnitř virtuální sítě, která má pouze intranetový koncový bod.
zones

Seznam zón dostupnosti označující, odkud prostředek musí pocházet.

Zděděné vlastnosti

id

ID prostředku. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
name

Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
tags

Značky prostředků
type

Typ prostředku služby API Management je nastavený na Microsoft.ApiManagement. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

Podrobnosti vlastnosti

additionalLocations

Další umístění datacenter služby API Management

additionalLocations?: AdditionalLocation[]

Hodnota vlastnosti

AdditionalLocation[]

apiVersionConstraint

Omezení verze APIS roviny řízení pro službu API Management

apiVersionConstraint?: ApiVersionConstraint

Hodnota vlastnosti

ApiVersionConstraint

certificates

Seznam certifikátů, které je potřeba nainstalovat ve službě API Management Maximální počet podporovaných certifikátů, které je možné nainstalovat, je 10.

certificates?: CertificateConfiguration[]

Hodnota vlastnosti

CertificateConfiguration[]

createdAtUtc

Datum vytvoření utc služby API Management Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

createdAtUtc?: Date

Hodnota vlastnosti

Date

customProperties

Vlastní vlastnosti služby API Management
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 zakáže TLS_RSA_WITH_3DES_EDE_CBC_SHA šifry pro všechny protokoly TLS(1.0, 1.1 a 1.2).
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 lze použít k zakázání pouze protokolu TLS 1.1.
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 lze použít k zakázání protokolu TLS 1.0 ve službě API Management.
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 lze použít k zakázání pouze protokolu TLS 1.1 pro komunikaci s back-endy.
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 lze použít k zakázání protokolu TLS 1.0 pro komunikaci s back-endy.
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 lze použít k povolení protokolu HTTP2 ve službě API Management.
Nezadání žádné z těchto vlastností v operaci PATCH resetuje hodnoty vynechaných vlastností na výchozí hodnoty. Pro všechna nastavení kromě Http2 je výchozí hodnota True, pokud byla služba vytvořena 1. dubna 2018 a False jinak. Výchozí hodnota nastavení Http2 je False.

Pomocí Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]nastavení můžete zakázat některou z následujících šifer: 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. Například Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Výchozí hodnota je true pro ně.
Poznámka: Následující šifry nelze zakázat, protože jsou vyžadovány interními komponentami platformy: 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}

Hodnota vlastnosti

{[propertyName: string]: string}

developerPortalUrl

Adresa URL koncového bodu portálu DEveloper služby API Management POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

developerPortalUrl?: string

Hodnota vlastnosti

string

disableGateway

Vlastnost platí pouze pro službu Api Management nasazenou ve více umístěních. To se dá použít k zakázání brány v hlavní oblasti.

disableGateway?: boolean

Hodnota vlastnosti

boolean

enableClientCertificate

Vlastnost má být použita pouze pro službu SKU Consumption. To vynucuje, aby se klientský certifikát zobrazoval na každém požadavku bráně. To také umožňuje ověřit certifikát v zásadách brány.

enableClientCertificate?: boolean

Hodnota vlastnosti

boolean

etag

ETag prostředku. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

etag?: string

Hodnota vlastnosti

string

gatewayRegionalUrl

Adresa URL brány služby API Management ve výchozí oblasti POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

gatewayRegionalUrl?: string

Hodnota vlastnosti

string

gatewayUrl

Adresa URL brány služby API Management POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

gatewayUrl?: string

Hodnota vlastnosti

string

hostnameConfigurations

Vlastní konfigurace názvu hostitele služby API Management

hostnameConfigurations?: HostnameConfiguration[]

Hodnota vlastnosti

HostnameConfiguration[]

identity

Identita spravované služby služby Api Management

identity?: ApiManagementServiceIdentity

Hodnota vlastnosti

ApiManagementServiceIdentity

managementApiUrl

Adresa URL koncového bodu rozhraní API pro správu služby API Management POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

managementApiUrl?: string

Hodnota vlastnosti

string

natGatewayState

Vlastnost se dá použít k povolení služby NAT Gateway pro tuto službu API Management.

natGatewayState?: string

Hodnota vlastnosti

string

notificationSenderEmail

E-mailová adresa, ze které se oznámení odešle.

notificationSenderEmail?: string

Hodnota vlastnosti

string

outboundPublicIPAddresses

Odchozí předpony veřejných IPV4 adres přidružených k nasazené službě NAT Gateway K dispozici pouze pro skladovou položku Premium na platformě stv2. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

outboundPublicIPAddresses?: string[]

Hodnota vlastnosti

string[]

platformVersion

Verze výpočetní platformy, na které běží služba v tomto umístění. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

platformVersion?: string

Hodnota vlastnosti

string

portalUrl

Adresa URL koncového bodu portálu vydavatele služby API Management POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

portalUrl?: string

Hodnota vlastnosti

string

privateEndpointConnections

Seznam připojení privátních koncových bodů této služby

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Hodnota vlastnosti

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

Privátní IP adresy služby API Management s vyrovnáváním zatížení v primární oblasti, která je nasazená v interní virtuální síti. K dispozici pouze pro SKU Basic, Standard, Premium a Isolated. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

privateIPAddresses?: string[]

Hodnota vlastnosti

string[]

provisioningState

Aktuální stav zřizování služby API Management, který může být jedním z následujících způsobů: Vytvoření, aktivace, úspěch, aktualizace, selhání, ukončení, ukončení nebo odstranění. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

provisioningState?: string

Hodnota vlastnosti

string

publicIPAddresses

Veřejné IP adresy služby API Management se statickým vyrovnáváním zatížení v primární oblasti K dispozici pouze pro SKU Basic, Standard, Premium a Isolated. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

publicIPAddresses?: string[]

Hodnota vlastnosti

string[]

publicIpAddressId

IP adresa založená na veřejné standardní SKU V4, která se má přidružit k nasazené službě virtuální sítě v dané oblasti. Podporuje se jenom pro SKU Pro vývojáře a Premium nasazené ve virtuální síti.

publicIpAddressId?: string

Hodnota vlastnosti

string

publicNetworkAccess

Určuje, jestli je pro tuto službu API Management povolený přístup k veřejnému koncovému bodu. Hodnota je nepovinná, ale pokud je předaná, musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, privátní koncové body jsou výhradní metodou přístupu. Výchozí hodnota je Enabled

publicNetworkAccess?: string

Hodnota vlastnosti

string

publisherEmail

E-mail vydavatele.

publisherEmail?: string

Hodnota vlastnosti

string

publisherName

Název vydavatele.

publisherName?: string

Hodnota vlastnosti

string

restore

Pokud byla dříve obnovitelně odstraněna, zrušte odstranění služby Api Management. Pokud je tento příznak zadaný a nastaví se na Hodnotu True, budou ignorovány všechny ostatní vlastnosti.

restore?: boolean

Hodnota vlastnosti

boolean

scmUrl

Adresa URL koncového bodu SCM služby API Management POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

scmUrl?: string

Hodnota vlastnosti

string

sku

Vlastnosti skladové položky služby API Management

sku?: ApiManagementServiceSkuProperties

Hodnota vlastnosti

ApiManagementServiceSkuProperties

targetProvisioningState

Stav zřizování služby API Management, na který cílí dlouhotrvající operace spuštěná ve službě. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

targetProvisioningState?: string

Hodnota vlastnosti

string

virtualNetworkConfiguration

Konfigurace virtuální sítě služby API Management

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Hodnota vlastnosti

VirtualNetworkConfiguration

virtualNetworkType

Typ sítě VPN, ve které je potřeba nakonfigurovat službu API Management. Žádná (výchozí hodnota) znamená, že služba API Management není součástí žádné virtuální sítě, externí znamená, že nasazení služby API Management je nastavené uvnitř virtuální sítě s internetovým koncovým bodem a interní znamená, že nasazení služby API Management je nastaveno uvnitř virtuální sítě, která má pouze intranetový koncový bod.

virtualNetworkType?: string

Hodnota vlastnosti

string

zones

Seznam zón dostupnosti označující, odkud prostředek musí pocházet.

zones?: string[]

Hodnota vlastnosti

string[]

Podrobnosti zděděných vlastností

id

ID prostředku. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

id?: string

Hodnota vlastnosti

string

zděděno zeApimResource.id

name

Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

name?: string

Hodnota vlastnosti

string

zděděno zeApimResource.name

tags

Značky prostředků

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

Hodnota vlastnosti

{[propertyName: string]: string}

zděděné zeapimResource.tags

type

Typ prostředku služby API Management je nastavený na Microsoft.ApiManagement. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

type?: string

Hodnota vlastnosti

string

zděděno zApimResource.type