Api Management Service - Refresh Hostnames

Služba:: API Management

Verze rozhraní API:: 2025-03-01-preview

Vynuceně obnovit SSL certifikát připojený k vlastním hostitelským jménům konfigurovaným pomocí tajemství z KeyVault ve službě Správy API.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/refreshHostnames?api-version=2025-03-01-preview

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Název služby API Management.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	ApiManagementServiceResource	Operace Azure byla úspěšně dokončena.
202 Accepted		Akceptovala se operace prostředku. Hlavičky Retry-After: integer location: string
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Name

Typ

Description

200 OK

ApiManagementServiceResource

Operace Azure byla úspěšně dokončena.

202 Accepted

Akceptovala se operace prostředku.

Hlavičky

Retry-After: integer
location: string

Other Status Codes

ErrorResponse

Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementServiceRefreshKeyVaultHostnames

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/refreshHostnames?api-version=2025-03-01-preview

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_service_refresh_key_vault_hostnames.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.api_management_service.begin_refresh_hostnames(
        resource_group_name="rg1",
        service_name="apimService1",
    ).result()
    print(response)


# x-ms-original-file: 2025-03-01-preview/ApiManagementServiceRefreshKeyVaultHostnames.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:: 200

{
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "etag": "AAAAAAK5GpM=",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "b413456e-a9c8-4242-9754-0a01c061bd41",
    "tenantId": "b413456e-a9c8-4242-9754-0a01c061bd41"
  },
  "location": "West Europe",
  "properties": {
    "additionalLocations": [
      {
        "disableGateway": false,
        "gatewayRegionalUrl": "https://apimService1-northeurope-01.regional.azure-api.net",
        "location": "North Europe",
        "outboundPublicIPAddresses": [
          "4.xxx.40.176"
        ],
        "platformVersion": "stv2",
        "publicIPAddresses": [
          "4.xxx.40.176"
        ],
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimVnet/subnets/default2"
        }
      }
    ],
    "createdAtUtc": "2016-04-12T00:20:15.6018952Z",
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True"
    },
    "developerPortalStatus": "Enabled",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "disableGateway": false,
    "gatewayRegionalUrl": "https://apimService1-westeurope-01.regional.azure-api.net",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "certificateSource": "BuiltIn",
        "defaultSslBinding": false,
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false
      },
      {
        "type": "Proxy",
        "certificate": {
          "expiry": "2025-12-18T11:11:47+00:00",
          "subject": "CN=*.msitesting.net",
          "thumbprint": "9833D531D7A45XXXXXXXXXXXX8BD392E0BD3F"
        },
        "certificateSource": "KeyVault",
        "defaultSslBinding": true,
        "hostName": "proxy.msitesting.net",
        "keyVaultId": "https://apim-msi-keyvault.vault.azure.net/secrets/sslcertificate",
        "negotiateClientCertificate": false
      }
    ],
    "legacyPortalStatus": "Disabled",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "natGatewayState": "Disabled",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "outboundPublicIPAddresses": [
      "57.xxx.61.xx"
    ],
    "platformVersion": "stv2.1",
    "provisioningState": "Succeeded",
    "publicIPAddresses": [
      "XX.153.XX.94"
    ],
    "publicNetworkAccess": "Enabled",
    "publisherEmail": "autorest@contoso.com",
    "publisherName": "Microsoft",
    "releaseChannel": "Default",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1/subnets/default"
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "systemData": {
    "lastModifiedAt": "2024-06-14T17:33:34.8195595Z",
    "lastModifiedBy": "autorest@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {}
}

Stavový kód:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2025-03-01-preview

Definice

Name	Description
AdditionalLocation	Popis dalšího umístění prostředku služby API Management.
ApiManagementServiceIdentity	Vlastnosti identity prostředku služby Api Management.
ApiManagementServiceResource	Jeden prostředek služby API Management v části Odpověď List nebo Get .
ApiManagementServiceSkuProperties	Vlastnosti SKU prostředku služby API Management.
ApimIdentityType	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.
ApiVersionConstraint	Omezení verze APIS roviny řízení pro službu API Management
ArmIdWrapper	Obálka pro ID prostředku ARM
CertificateConfiguration	Konfigurace certifikátů, které se skládají z nedůvěryhodných zprostředkujících certifikátů a kořenových certifikátů.
CertificateConfigurationStoreName	Umístění úložiště certifikátů System.Security.Cryptography.x509certificates.StoreName. Platná umístění jsou pouze root a CertificateAuthority.
CertificateInformation	Informace o certifikátu SSL.
CertificateSource	Zdroj certifikátu.
CertificateStatus	Stav certifikátu.
ConfigurationApi	Informace týkající se konfiguračního rozhraní API služby API Management.
createdByType	Typ identity, která prostředek vytvořila.
DeveloperPortalStatus	Stav portálu pro vývojáře v této službě API Management
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
HostnameConfiguration	Konfigurace vlastního názvu hostitele.
HostnameType	Typ názvu hostitele.
LegacyApiState	Indikuje, jestli má být ve službě API Management zpřístupněno starší verze konfiguračního rozhraní API (v1). Hodnota je nepovinná, ale musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, starší verze rozhraní API konfigurace (v1) nebude k dispozici pro brány v místním prostředí. Výchozí hodnota je Enabled
LegacyPortalStatus	Stav starší verze portálu ve službě API Management
NatGatewayState	Vlastnost se dá použít k povolení služby NAT Gateway pro tuto službu API Management.
PlatformVersion	Verze výpočetní platformy, na které služba běží.
PrivateEndpointServiceConnectionStatus	Stav připojení privátního koncového bodu.
PrivateLinkServiceConnectionState	Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.
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
ReleaseChannel	Kanál vydání této služby API Management.
RemotePrivateEndpointConnectionWrapper	Prostředek připojení vzdáleného privátního koncového bodu.
SkuType	Název skladové položky.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
UserIdentityProperties
VirtualNetworkConfiguration	Konfigurace virtuální sítě, do které je služba API Management nasazená.
VirtualNetworkType	Typ sítě VPN, ve které je potřeba nakonfigurovat bránu služby API Management.

AdditionalLocation

Objekt

Popis dalšího umístění prostředku služby API Management.

Name	Typ	Default value	Description
disableGateway	boolean	False	Vlastnost platí pouze pro službu Api Management nasazenou ve více umístěních. Tuto možnost můžete použít k zakázání brány v tomto dalším umístění.
gatewayRegionalUrl	string		Adresa URL brány služby API Management v oblasti.
location	string		Název umístění další oblasti mezi oblastmi Azure Data Center.
natGatewayState	NatGatewayState	Disabled	Vlastnost se dá použít k povolení služby NAT Gateway pro tuto službu API Management.
outboundPublicIPAddresses	string[]		Předpony odchozích veřejných adres IPV4 přidružené k nasazené službě služby služby NAT Gateway. K dispozici pouze pro Premium SKU na platformě stv2.
platformVersion	PlatformVersion		Verze výpočetní platformy, na které služba běží.
privateIPAddresses	string[]		Privátní statické IP adresy služby API Management s vyrovnáváním zatížení, která je nasazená v interní virtuální síti v konkrétním dalším umístění. K dispozici pouze pro skladovou položku Basic, Standard, Premium a Single.
publicIPAddresses	string[]		Veřejné statické zatížení Vyrovnává zatížení IP adresy služby API Management v dalším umístění. K dispozici pouze pro skladovou položku Basic, Standard, Premium a Single.
publicIpAddressId	string		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 umístění. Podporuje se jenom nasazení skladové položky Premium ve virtuální síti.
sku	ApiManagementServiceSkuProperties		Vlastnosti skladové položky služby API Management
virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfigurace virtuální sítě pro umístění
zones	string[]		Seznam zón dostupnosti označující, odkud prostředek musí pocházet.

ApiManagementServiceIdentity

Objekt

Vlastnosti identity prostředku služby Api Management.

Name	Typ	Description
principalId	string (uuid)	ID objektu zabezpečení identity.
tenantId	string (uuid)	ID tenanta klienta identity.
type	ApimIdentityType	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.
userAssignedIdentities	<string, UserIdentityProperties>	Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

ApiManagementServiceResource

Objekt

Jeden prostředek služby API Management v části Odpověď List nebo Get .

Name	Typ	Default value	Description
etag	string		ETag prostředku.
id	string		Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ApiManagementServiceIdentity		Identita spravované služby služby Api Management
location	string		Geografické umístění, ve kterém se nachází zdroj
name	string		Název prostředku
properties.additionalLocations	AdditionalLocation[]		Další umístění datacenter služby API Management
properties.apiVersionConstraint	ApiVersionConstraint		Omezení verze APIS roviny řízení pro službu API Management
properties.certificates	CertificateConfiguration[]		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.
properties.configurationApi	ConfigurationApi		Konfigurace rozhraní API konfigurace služby API Management
properties.createdAtUtc	string (date-time)		Datum vytvoření služby API Management v čase UTC. Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` jak je specifikováno normou ISO 8601.
properties.customProperties	object		Vlastní vlastnosti služby API Management. Toto nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` zakáže šifrovací TLS_RSA_WITH_3DES_EDE_CBC_SHA pro všechny TLS (1.0, 1.1 a 1.2). Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` lze použít k vypnutí pouze TLS 1.1. Toto 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ím `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` lze zakázat pouze TLS 1.1 pro komunikaci s backendy. Toto 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. Toto nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` lze použít k povolení protokolu HTTP2 ve službě API Management. Pokud v operaci PATCH neurčíte žádnou z těchto vlastností, obnoví se 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`. Kteroukoli z následujících šifer můžete zakázat pomocí nastavení `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. 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
properties.developerPortalStatus	DeveloperPortalStatus	Enabled	Stav portálu pro vývojáře v této službě API Management
properties.developerPortalUrl	string		Adresa URL koncového bodu portálu DEveloper služby API Management.
properties.disableGateway	boolean	False	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.
properties.enableClientCertificate	boolean	False	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.
properties.gatewayRegionalUrl	string		Adresa URL brány služby API Management ve výchozí oblasti.
properties.gatewayUrl	string		Adresa URL brány služby API Management.
properties.hostnameConfigurations	HostnameConfiguration[]		Vlastní konfigurace názvu hostitele služby API Management
properties.legacyPortalStatus	LegacyPortalStatus	Enabled	Stav starší verze portálu ve službě API Management
properties.managementApiUrl	string		Adresa URL koncového bodu rozhraní API pro správu služby API Management.
properties.natGatewayState	NatGatewayState	Disabled	Vlastnost se dá použít k povolení služby NAT Gateway pro tuto službu API Management.
properties.notificationSenderEmail	string maxLength: 100		E-mailová adresa, ze které se oznámení odešle.
properties.outboundPublicIPAddresses	string[]		Předpony odchozích veřejných adres IPV4 přidružené k nasazené službě služby služby NAT Gateway. K dispozici pouze pro Premium SKU na platformě stv2.
properties.platformVersion	PlatformVersion		Verze výpočetní platformy, na které je služba spuštěna v tomto umístění.
properties.portalUrl	string		Koncový bod portálu pro vydavatele Adresa URL služby API Management.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Seznam připojení privátních koncových bodů této služby
properties.privateIPAddresses	string[]		Privátní statické zatížení Adresy IP služby API Management v primární oblasti, která je nasazená v interní virtuální síti. K dispozici pouze pro skladovou položku Basic, Standard, Premium a Single.
properties.provisioningState	string		Aktuální stav zřizování služby API Management, který může být jeden z následujících: Vytvořeno/Aktivace/Úspěch/Aktualizace/Selhání/Zastaveno/Ukončení/Selhání/Odstraněno.
properties.publicIPAddresses	string[]		Veřejné statické zatížení Vyrovnávání zatížení IP adresy služby API Management v primární oblasti. K dispozici pouze pro skladovou položku Basic, Standard, Premium a Single.
properties.publicIpAddressId	string		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.
properties.publicNetworkAccess	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
properties.publisherEmail	string maxLength: 100		E-mail vydavatele.
properties.publisherName	string maxLength: 100		Název vydavatele.
properties.releaseChannel	ReleaseChannel		Kanál vydání této služby API Management.
properties.restore	boolean	False	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.
properties.scmUrl	string		Adresa URL koncového bodu SCM služby API Management.
properties.targetProvisioningState	string		Stav zřizování služby API Management, na kterou cílí dlouhotrvající operace spuštěná ve službě.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfigurace virtuální sítě služby API Management
properties.virtualNetworkType	VirtualNetworkType	None	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.
properties.zoneRedundant	boolean	False	Požadavek na redundantní zónu při vytváření StandardV2 a PremiumV2. Pokud je tento příznak nastaven na True, vrátí se APIM služba se zónovou redundantní nebo požadavek selže, pokud žádná podkomponenta nemůže být zónově redundantní.
sku	ApiManagementServiceSkuProperties		Vlastnosti skladové položky služby API Management
systemData	systemData		Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
tags	object		Značky prostředků
type	string		Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"
zones	string[]		Zóny dostupnosti.

ApiManagementServiceSkuProperties

Objekt

Vlastnosti SKU prostředku služby API Management.

Name	Typ	Description
capacity	integer (int32)	Kapacita skladové položky (počet nasazených jednotek skladové položky). Pro kapacitu skladové položky Consumption musí být zadána jako 0.
name	SkuType	Název skladové položky.

ApimIdentityType

Výčet

Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.

Hodnota	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ApiVersionConstraint

Objekt

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

Name	Typ	Description
minApiVersion	string	Omezte volání rozhraní API řídicí roviny do služby API Management s verzí rovnající se nebo novější než tato hodnota.

ArmIdWrapper

Objekt

Obálka pro ID prostředku ARM

Name	Typ	Description
id	string

CertificateConfiguration

Objekt

Konfigurace certifikátů, které se skládají z nedůvěryhodných zprostředkujících certifikátů a kořenových certifikátů.

Name	Typ	Description
certificate	CertificateInformation	Informace o certifikátu
certificatePassword	string	Heslo certifikátu.
encodedCertificate	string	Kódovaný certifikát Base64
storeName	CertificateConfigurationStoreName	Umístění úložiště certifikátů System.Security.Cryptography.x509certificates.StoreName. Platná umístění jsou pouze root a CertificateAuthority.

CertificateConfigurationStoreName

Výčet

Umístění úložiště certifikátů System.Security.Cryptography.x509certificates.StoreName. Platná umístění jsou pouze root a CertificateAuthority.

Hodnota	Description
CertificateAuthority
Root

CertificateInformation

Objekt

Informace o certifikátu SSL.

Name	Typ	Description
expiry	string (date-time)	Datum vypršení platnosti certifikátu Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle normy ISO 8601.
subject	string	Předmět certifikátu.
thumbprint	string	Kryptografický otisk certifikátu.

CertificateSource

Výčet

Zdroj certifikátu.

Hodnota	Description
Managed
KeyVault
Custom
BuiltIn

CertificateStatus

Výčet

Stav certifikátu.

Hodnota	Description
Completed
Failed
InProgress

ConfigurationApi

Objekt

Informace týkající se konfiguračního rozhraní API služby API Management.

Name	Typ	Default value	Description
legacyApi	LegacyApiState	Enabled	Indikuje, jestli má být ve službě API Management zpřístupněno starší verze konfiguračního rozhraní API (v1). Hodnota je nepovinná, ale musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, starší verze rozhraní API konfigurace (v1) nebude k dispozici pro brány v místním prostředí. Výchozí hodnota je Enabled

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DeveloperPortalStatus

Výčet

Stav portálu pro vývojáře v této službě API Management

Hodnota	Description
Enabled	Pro službu je povolen portál pro vývojáře.
Disabled	Portál pro vývojáře je pro tuto službu zakázán.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

HostnameConfiguration

Objekt

Konfigurace vlastního názvu hostitele.

Name	Typ	Default value	Description
certificate	CertificateInformation		Informace o certifikátu
certificatePassword	string		Heslo certifikátu.
certificateSource	CertificateSource		Zdroj certifikátu.
certificateStatus	CertificateStatus		Stav certifikátu.
defaultSslBinding	boolean	False	Zadejte hodnotu true pro nastavení certifikátu přidruženého k tomuto názvu hostitele jako výchozího certifikátu SSL. Pokud klient neodešle hlavičku SNI, bude to certifikát, který bude vyzván. Tato vlastnost je užitečná, pokud má služba povolených více vlastních názvů hostitelů a musí se rozhodnout o výchozím certifikátu SSL. Nastavení použité pouze pro typ názvu hostitele brány.
encodedCertificate	string		Kódovaný certifikát Base64
hostName	string		Název hostitele pro konfiguraci ve službě Api Management.
identityClientId	string		ID klienta spravované identity přiřazené systémem nebo uživatelem vygenerované službou Azure AD, který má přístup GET ke službě keyVault obsahující certifikát SSL.
keyVaultId	string		Adresa URL tajného klíče služby KeyVault obsahující certifikát SSL. Pokud je k dispozici absolutní adresa URL obsahující verzi, automatická aktualizace certifikátu SSL nebude fungovat. To vyžaduje, aby služba Api Management byla nakonfigurovaná s aka.ms/apimmsi. Tajný kód by měl být typu application/x-pkcs12
negotiateClientCertificate	boolean	False	Zadejte true pro vždy vyjednání klientského certifikátu na názvu hostitele. Výchozí hodnota je false.
type	HostnameType		Typ názvu hostitele.

HostnameType

Výčet

Typ názvu hostitele.

Hodnota	Description
Proxy
Portal
Management
Scm
DeveloperPortal
ConfigurationApi

LegacyApiState

Výčet

Indikuje, jestli má být ve službě API Management zpřístupněno starší verze konfiguračního rozhraní API (v1). Hodnota je nepovinná, ale musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, starší verze rozhraní API konfigurace (v1) nebude k dispozici pro brány v místním prostředí. Výchozí hodnota je Enabled

Hodnota	Description
Enabled	Pro službu je povoleno starší konfigurační rozhraní API (v1) a brány v místním prostředí se k němu mohou připojit.
Disabled	Starší konfigurační rozhraní API (v1) je pro službu zakázané a brány v místním prostředí se k němu nemohou připojit.

LegacyPortalStatus

Výčet

Stav starší verze portálu ve službě API Management

Hodnota	Description
Enabled	Pro službu je povolen starší portál.
Disabled	Starší verze portálu je pro službu zakázána.

NatGatewayState

Výčet

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

Hodnota	Description
Enabled	Pro službu je povolena brána Nat Gateway.
Disabled	Služba Nat Gateway je pro tuto službu zakázána.

PlatformVersion

Výčet

Verze výpočetní platformy, na které služba běží.

Hodnota	Description
undetermined	Verzi platformy nelze určit, protože není nasazena výpočetní platforma.
stv1	Platforma, na které služba běží na platformě Single Tenant V1.
stv2	Platforma, na které služba běží na platformě Single Tenant V2.
mtv1	Platforma provozující službu na platformě Multi Tenant V1.
stv2.1	Platforma provozující službu na platformě Single Tenant V2 na novějším hardwaru.

PrivateEndpointServiceConnectionStatus

Výčet

Stav připojení privátního koncového bodu.

Hodnota	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Objekt

Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.

Name	Typ	Description
actionsRequired	string	Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.
description	string	Důvod schválení nebo zamítnutí připojení.
status	PrivateEndpointServiceConnectionStatus	Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby.

PublicNetworkAccess

Výčet

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

Hodnota	Description
Enabled
Disabled

ReleaseChannel

Výčet

Kanál vydání této služby API Management.

Hodnota	Description
Preview	Náhled Kanál služby.
Default	Výchozí kanál služby.
Stable	Stabilní kanál služby.

RemotePrivateEndpointConnectionWrapper

Objekt

Prostředek připojení vzdáleného privátního koncového bodu.

Name	Typ	Description
id	string	ID prostředku připojení privátního koncového bodu
name	string	Název připojení privátního koncového bodu
properties.groupIds	string[]	Všechna ID skupiny.
properties.privateEndpoint	ArmIdWrapper	Prostředek privátního koncového bodu.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.
properties.provisioningState	string	Stav zřizování prostředku připojení privátního koncového bodu.
type	string	Typ prostředku připojení privátního koncového bodu

SkuType

Výčet

Název skladové položky.

Hodnota	Description
Developer	SKU vývojáře služby Api Management.
Standard	Standardní SKU služby Api Management.
Premium	Prémiová SKU služby Api Management.
Basic	Základní SKU služby Api Management.
Consumption	Skladová položka spotřeby služby Api Management.
Isolated	Izolovaná SKU služby Api Management.
BasicV2	Skladová položka BasicV2 služby Api Management.
StandardV2	Skladová položka StandardV2 služby Api Management.
PremiumV2	PremiumV2 SKU správy API.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UserIdentityProperties

Objekt

Name	Typ	Description
clientId	string	ID klienta identity přiřazené uživatelem.
principalId	string	ID objektu zabezpečení identity přiřazené uživatelem.

VirtualNetworkConfiguration

Objekt

Konfigurace virtuální sítě, do které je služba API Management nasazená.

Name	Typ	Description
subnetResourceId	string pattern: ^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$	Úplné ID prostředku podsítě ve virtuální síti pro nasazení služby API Management do.
subnetname	string	Název podsítě.
vnetid	string	ID virtuální sítě. Obvykle se jedná o identifikátor GUID. Ve výchozím nastavení očekávejte identifikátor GUID s hodnotou null.

VirtualNetworkType

Výčet

Typ sítě VPN, ve které je potřeba nakonfigurovat bránu služby API Management.

Hodnota	Description
None	Brána služby API Management není součástí žádné virtuální sítě.
External	Brána API Management je součástí Virtual Network a je přístupná z internetu.
Internal	Brána API Management je součástí Virtual Network a je přístupná pouze z virtuální sítě.

Sdílet prostřednictvím

Api Management Service - Refresh Hostnames

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

ApiManagementServiceRefreshKeyVaultHostnames

Ukázkový požadavek

Ukázková odpověď

Definice

AdditionalLocation

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateConfigurationStoreName

CertificateInformation

CertificateSource

CertificateStatus

ConfigurationApi

createdByType

DeveloperPortalStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HostnameConfiguration

HostnameType

LegacyApiState

LegacyPortalStatus

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

ReleaseChannel

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType