Sdílet prostřednictvím

ApiManagementServiceProperties interface

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

Vlastnosti popisu prostředku služby Gestione API.

Extends
ApiManagementServiceBaseProperties

Vlastnosti

publisherEmail

E-mail vydavatele.
publisherName

Název vydavatele.

Zděděné vlastnosti

additionalLocations

Další umístění datacentra služby Gestione API.
apiVersionConstraint

Omezení verze rozhraní API řídicí roviny pro službu Gestione API.
certificates

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

Datum vytvoření služby Gestione API (UTC). 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. Naplnit ho může jenom server.
customProperties

Vlastní vlastnosti služby Gestione API.
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 zakáže šifrovací TLS_RSA_WITH_3DES_EDE_CBC_SHA 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 se dá použít k zakázání protokolu TLS 1.0 ve službě Gestione API.
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ě Gestione API.
Nezadání žádné z těchto vlastností v operaci PATCH obnoví výchozí hodnoty vynechaných vlastností. Pro všechna nastavení kromě Http2 je výchozí hodnota, pokud byla True služba vytvořena 1. dubna 2018 nebo dříve a False jinak. Výchozí hodnota nastavení HTTP2 je False.

Pomocí nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]můžete zakázat libovolnou 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 Gestione API. POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
disableGateway

Vlastnost je platná jenom 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 určená pouze k použití pro službu consumption SKU. Tím se vynutí předložení klientského certifikátu bráně při každém požadavku. To také umožňuje ověřit certifikát v zásadách na bráně.
gatewayRegionalUrl

Adresa URL brány služby Gestione API ve výchozí oblasti. POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
gatewayUrl

Adresa URL brány služby Gestione API. POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
hostnameConfigurations

Konfigurace vlastního názvu hostitele služby Gestione API.
managementApiUrl

Adresa URL koncového bodu rozhraní API pro správu služby Gestione API. POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
natGatewayState

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

Email adresu, ze které se oznámení odešle.
outboundPublicIPAddresses

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

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

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

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

Privátní IP adresy s vyrovnáváním statického zatížení služby Gestione API v primární oblasti, která je nasazená v interním Virtual Network. K dispozici pouze pro skladovou položku Basic, Standard, Premium a Isolated. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.
provisioningState

Aktuální stav zřizování služby Gestione API, který může být jeden z následujících: Vytvoření/Aktivace/Úspěšné/Aktualizace/Selhání/Zastaveno/Ukončení/Ukončení Selhalo/Odstraněno. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.
publicIPAddresses

Veřejné IP adresy s vyrovnáváním statického zatížení služby Gestione API v primární oblasti. K dispozici pouze pro skladovou položku Basic, Standard, Premium a Isolated. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.
publicIpAddressId

IP adresa založená na veřejné SKU Standard IP verze 4, která se má přidružit k Virtual Network nasazené službě v dané oblasti. Podporováno pouze pro SKU Developer a Premium nasazené v Virtual Network.
publicNetworkAccess

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

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

Adresa URL koncového bodu SCM služby Gestione API. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.
targetProvisioningState

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

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

Typ sítě VPN, ve které je potřeba nakonfigurovat službu Gestione API. None (výchozí hodnota) znamená, že služba Gestione API není součástí žádného Virtual Network. Externí znamená, že nasazení Gestione API je nastavené uvnitř Virtual Network, který má internetový koncový bod, a interní znamená, že je nastavené nasazení Gestione API. uvnitř Virtual Network, který má pouze intranetový koncový bod.

Podrobnosti vlastnosti

publisherEmail

E-mail vydavatele.

publisherEmail: string

Hodnota vlastnosti

string

publisherName

Název vydavatele.

publisherName: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

additionalLocations

Další umístění datacentra služby Gestione API.

additionalLocations?: AdditionalLocation[]

Hodnota vlastnosti

AdditionalLocation[]

Zděděno zApiManagementServiceBaseProperties.additionalLocations

apiVersionConstraint

Omezení verze rozhraní API řídicí roviny pro službu Gestione API.

apiVersionConstraint?: ApiVersionConstraint

Hodnota vlastnosti

ApiVersionConstraint

Zděděno zApiManagementServiceBaseProperties.apiVersionConstraint

certificates

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

certificates?: CertificateConfiguration[]

Hodnota vlastnosti

CertificateConfiguration[]

Zděděno zapiManagementServiceBaseProperties.certificates

createdAtUtc

Datum vytvoření služby Gestione API (UTC). 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. Naplnit ho může jenom server.

createdAtUtc?: Date

Hodnota vlastnosti

Date

Zděděno zApiManagementServiceBaseProperties.createdAtUtc

customProperties

Vlastní vlastnosti služby Gestione API.
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 zakáže šifrovací TLS_RSA_WITH_3DES_EDE_CBC_SHA 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 se dá použít k zakázání protokolu TLS 1.0 ve službě Gestione API.
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ě Gestione API.
Nezadání žádné z těchto vlastností v operaci PATCH obnoví výchozí hodnoty vynechaných vlastností. Pro všechna nastavení kromě Http2 je výchozí hodnota, pokud byla True služba vytvořena 1. dubna 2018 nebo dříve a False jinak. Výchozí hodnota nastavení HTTP2 je False.

Pomocí nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]můžete zakázat libovolnou 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}

Zděděno zApiManagementServiceBaseProperties.customProperties

developerPortalUrl

Adresa URL koncového bodu portálu DEveloper služby Gestione API. POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.

developerPortalUrl?: string

Hodnota vlastnosti

string

Zděděno zApiManagementServiceBaseProperties.developerPortalUrl

disableGateway

Vlastnost je platná jenom 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

Zděděno zApiManagementServiceBaseProperties.disableGateway

enableClientCertificate

Vlastnost určená pouze k použití pro službu consumption SKU. Tím se vynutí předložení klientského certifikátu bráně při každém požadavku. To také umožňuje ověřit certifikát v zásadách na bráně.

enableClientCertificate?: boolean

Hodnota vlastnosti

boolean

Zděděno zApiManagementServiceBaseProperties.enableClientCertificate

gatewayRegionalUrl

Adresa URL brány služby Gestione API ve výchozí oblasti. POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.

gatewayRegionalUrl?: string

Hodnota vlastnosti

string

Zděděno zapiManagementServiceBaseProperties.gatewayRegionalUrl

gatewayUrl

Adresa URL brány služby Gestione API. POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.

gatewayUrl?: string

Hodnota vlastnosti

string

Zděděno zadresy ApiManagementServiceBaseProperties.gatewayUrl

hostnameConfigurations

Konfigurace vlastního názvu hostitele služby Gestione API.

hostnameConfigurations?: HostnameConfiguration[]

Hodnota vlastnosti

HostnameConfiguration[]

Zděděno zApiManagementServiceBaseProperties.hostnameConfigurations

managementApiUrl

Adresa URL koncového bodu rozhraní API pro správu služby Gestione API. POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.

managementApiUrl?: string

Hodnota vlastnosti

string

Zděděno zApiManagementServiceBaseProperties.managementApiUrl

natGatewayState

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

natGatewayState?: string

Hodnota vlastnosti

string

Zděděno zApiManagementServiceBaseProperties.natGatewayState

notificationSenderEmail

Email adresu, ze které se oznámení odešle.

notificationSenderEmail?: string

Hodnota vlastnosti

string

Zděděno zApiManagementServiceBaseProperties.notificationSenderEmail

outboundPublicIPAddresses

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

outboundPublicIPAddresses?: string[]

Hodnota vlastnosti

string[]

Zděděno zApiManagementServiceBaseProperties.outboundPublicIPAddresses

platformVersion

Verze výpočetní platformy, na které se služba spouští v tomto umístění. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.

platformVersion?: string

Hodnota vlastnosti

string

Zděděno zapiManagementServiceBaseProperties.platformVersion

portalUrl

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

portalUrl?: string

Hodnota vlastnosti

string

Zděděno zapiManagementServiceBaseProperties.portalUrl

privateEndpointConnections

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

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Hodnota vlastnosti

RemotePrivateEndpointConnectionWrapper[]

Zděděno zapiManagementServiceBaseProperties.privateEndpointConnections

privateIPAddresses

Privátní IP adresy s vyrovnáváním statického zatížení služby Gestione API v primární oblasti, která je nasazená v interním Virtual Network. K dispozici pouze pro skladovou položku Basic, Standard, Premium a Isolated. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.

privateIPAddresses?: string[]

Hodnota vlastnosti

string[]

Zděděno zapiManagementServiceBaseProperties.privateIPAddresses

provisioningState

Aktuální stav zřizování služby Gestione API, který může být jeden z následujících: Vytvoření/Aktivace/Úspěšné/Aktualizace/Selhání/Zastaveno/Ukončení/Ukončení Selhalo/Odstraněno. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.

provisioningState?: string

Hodnota vlastnosti

string

Zděděno zapiManagementServiceBaseProperties.provisioningState

publicIPAddresses

Veřejné IP adresy s vyrovnáváním statického zatížení služby Gestione API v primární oblasti. K dispozici pouze pro skladovou položku Basic, Standard, Premium a Isolated. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.

publicIPAddresses?: string[]

Hodnota vlastnosti

string[]

Zděděno zapiManagementServiceBaseProperties.publicIPAddresses

publicIpAddressId

IP adresa založená na veřejné SKU Standard IP verze 4, která se má přidružit k Virtual Network nasazené službě v dané oblasti. Podporováno pouze pro SKU Developer a Premium nasazené v Virtual Network.

publicIpAddressId?: string

Hodnota vlastnosti

string

Zděděno zapiManagementServiceBaseProperties.publicIpAddressId

publicNetworkAccess

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

publicNetworkAccess?: string

Hodnota vlastnosti

string

Zděděno zapiManagementServiceBaseProperties.publicNetworkAccess

restore

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

restore?: boolean

Hodnota vlastnosti

boolean

Zděděno zapiManagementServiceBaseProperties.restore

scmUrl

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

scmUrl?: string

Hodnota vlastnosti

string

Zděděno zapiManagementServiceBaseProperties.scmUrl

targetProvisioningState

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

targetProvisioningState?: string

Hodnota vlastnosti

string

Zděděno zapiManagementServiceBaseProperties.targetProvisioningState

virtualNetworkConfiguration

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

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Hodnota vlastnosti

VirtualNetworkConfiguration

Zděděno zapiManagementServiceBaseProperties.virtualNetworkConfiguration

virtualNetworkType

Typ sítě VPN, ve které je potřeba nakonfigurovat službu Gestione API. None (výchozí hodnota) znamená, že služba Gestione API není součástí žádného Virtual Network. Externí znamená, že nasazení Gestione API je nastavené uvnitř Virtual Network, který má internetový koncový bod, a interní znamená, že je nastavené nasazení Gestione API. uvnitř Virtual Network, který má pouze intranetový koncový bod.

virtualNetworkType?: string

Hodnota vlastnosti

string

Zděděno zapiManagementServiceBaseProperties.virtualNetworkType