Sdílet prostřednictvím

ApiManagementServiceResource interface

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

Jeden prostředek služby Gestione API v seznamu nebo získání odpovědi.

Extends
ApimResource

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. Může ho naplnit pouze 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 lze 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í hodnoty vynechaných vlastností na výchozí hodnoty. Pro všechna nastavení kromě Http2 je True výchozí hodnota, pokud byla služba vytvořená 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 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_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA. Pří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. Může ho naplnit pouze server.
disableGateway

Vlastnost platí jenom pro službu Api Management nasazenou na více místech. 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 SKU Consumption. Tím se vynutí předložení klientského certifikátu při každém požadavku bráně. To také umožňuje ověřit certifikát v zásadách na bráně.
etag

Značka ETag prostředku. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.
gatewayRegionalUrl

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

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

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

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

Umístění prostředku.
managementApiUrl

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

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

Email adresu, ze které bude oznámení odesláno.
outboundPublicIPAddresses

Odchozí předpony veřejných IPV4 adres přidružené ke službě nasazené službě 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.
publisherEmail

E-mail vydavatele.
publisherName

Název vydavatele.
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.
sku

Vlastnosti skladové položky služby Gestione API.
systemData

Metadata týkající se vytvoření a poslední změny prostředku 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.
zones

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

Zděděné vlastnosti

id

ID prostředku. POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
name

Název prostředku. POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
tags

Značky prostředků.
type

Typ prostředku pro prostředek Gestione API je nastavený na Microsoft.ApiManagement. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.

Podrobnosti vlastnosti

additionalLocations

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

additionalLocations?: AdditionalLocation[]

Hodnota vlastnosti

AdditionalLocation[]

apiVersionConstraint

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

apiVersionConstraint?: ApiVersionConstraint

Hodnota vlastnosti

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

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. Může ho naplnit pouze server.

createdAtUtc?: Date

Hodnota vlastnosti

Date

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 lze 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í hodnoty vynechaných vlastností na výchozí hodnoty. Pro všechna nastavení kromě Http2 je True výchozí hodnota, pokud byla služba vytvořená 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 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_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA. Pří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 Gestione API. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.

developerPortalUrl?: string

Hodnota vlastnosti

string

disableGateway

Vlastnost platí jenom pro službu Api Management nasazenou na více místech. To se dá použít k zakázání brány v hlavní oblasti.

disableGateway?: boolean

Hodnota vlastnosti

boolean

enableClientCertificate

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

enableClientCertificate?: boolean

Hodnota vlastnosti

boolean

etag

Značka ETag prostředku. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.

etag?: string

Hodnota vlastnosti

string

gatewayRegionalUrl

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

gatewayRegionalUrl?: string

Hodnota vlastnosti

string

gatewayUrl

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

gatewayUrl?: string

Hodnota vlastnosti

string

hostnameConfigurations

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

hostnameConfigurations?: HostnameConfiguration[]

Hodnota vlastnosti

HostnameConfiguration[]

identity

Identita spravované služby služby Api Management

identity?: ApiManagementServiceIdentity

Hodnota vlastnosti

ApiManagementServiceIdentity

location

Umístění prostředku.

location: string

Hodnota vlastnosti

string

managementApiUrl

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

managementApiUrl?: string

Hodnota vlastnosti

string

natGatewayState

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

natGatewayState?: string

Hodnota vlastnosti

string

notificationSenderEmail

Email adresu, ze které bude oznámení odesláno.

notificationSenderEmail?: string

Hodnota vlastnosti

string

outboundPublicIPAddresses

Odchozí předpony veřejných IPV4 adres přidružené ke službě nasazené službě 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[]

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

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

privateEndpointConnections

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

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Hodnota vlastnosti

RemotePrivateEndpointConnectionWrapper[]

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

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

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

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

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

publisherEmail

E-mail vydavatele.

publisherEmail: string

Hodnota vlastnosti

string

publisherName

Název vydavatele.

publisherName: string

Hodnota vlastnosti

string

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

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

sku

Vlastnosti skladové položky služby Gestione API.

sku: ApiManagementServiceSkuProperties

Hodnota vlastnosti

ApiManagementServiceSkuProperties

systemData

Metadata týkající se vytvoření a poslední změny prostředku POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.

systemData?: SystemData

Hodnota vlastnosti

SystemData

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

virtualNetworkConfiguration

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

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Hodnota vlastnosti

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

zones

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

zones?: string[]

Hodnota vlastnosti

string[]

Podrobnosti zděděných vlastností

id

ID prostředku. POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.

id?: string

Hodnota vlastnosti

string

Zděděno zApimResource.id

name

Název prostředku. POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.

name?: string

Hodnota vlastnosti

string

Zděděno zApimResource.name

tags

Značky prostředků.

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

Hodnota vlastnosti

{[propertyName: string]: string}

Zděděno zApimResource.tags

type

Typ prostředku pro prostředek Gestione API je nastavený na Microsoft.ApiManagement. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.

type?: string

Hodnota vlastnosti

string

Zděděno zapimResource.type