Api Management Service - Refresh Hostnames

Service:: API Management

API-versie:: 2025-03-01-preview

Forceer het SSL-certificaat dat is gekoppeld aan de aangepaste hostnamen die zijn geconfigureerd met geheim van KeyVault op de API-beheerservice.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	ApiManagementServiceResource	Azure-bewerking is voltooid.
202 Accepted		Resourcebewerking geaccepteerd. Kopteksten Retry-After: integer location: string
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Name

Type

Description

200 OK

ApiManagementServiceResource

Azure-bewerking is voltooid.

202 Accepted

Resourcebewerking geaccepteerd.

Kopteksten

Retry-After: integer
location: string

Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	zich voordoen als uw gebruikersaccount

Voorbeelden

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

Voorbeeldrespons

Statuscode:: 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": {}
}

Statuscode:: 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

Definities

Name	Description
AdditionalLocation	Beschrijving van een extra API Management-resourcelocatie.
ApiManagementServiceIdentity	Identiteitseigenschappen van de Api Management-serviceresource.
ApiManagementServiceResource	Eén API Management-serviceresource in Lijst of Antwoord ophalen.
ApiManagementServiceSkuProperties	SKU-eigenschappen van API Management-serviceresource.
ApimIdentityType	Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.
ApiVersionConstraint	Versiebeperking van Control Plane Apis voor de API Management-service.
ArmIdWrapper	Een wrapper voor een ARM-resource-id
CertificateConfiguration	Certificaatconfiguratie die bestaat uit niet-vertrouwde tussenproducten en basiscertificaten.
CertificateConfigurationStoreName	De locatie van het certificaatarchief System.Security.Cryptography.x509certificates.StoreName. Alleen root en CertificateAuthority zijn geldige locaties.
CertificateInformation	Informatie over SSL-certificaten.
CertificateSource	Bron certificaat.
CertificateStatus	Status van het certificaat.
ConfigurationApi	Informatie over de configuratie-API van de API Management-service.
createdByType	Het type identiteit waarmee de resource is gemaakt.
DeveloperPortalStatus	Status van de ontwikkelaarsportal in deze API Management-service.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
HostnameConfiguration	Aangepaste hostnaamconfiguratie.
HostnameType	Type hostnaam.
LegacyApiState	Indicatie of de verouderde configuratie-API (v1) al dan niet moet worden weergegeven op de API Management-service. De waarde is optioneel, maar moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als 'Uitgeschakeld', is de verouderde configuratie-API (v1) niet beschikbaar voor zelf-hostende gateways. De standaardwaarde is Ingeschakeld
LegacyPortalStatus	Status van de verouderde portal in de API Management-service.
NatGatewayState	Eigenschap kan worden gebruikt om NAT Gateway in te schakelen voor deze API Management-service.
PlatformVersion	Compute Platform Versie waarop de service wordt uitgevoerd.
PrivateEndpointServiceConnectionStatus	De verbindingsstatus van het privé-eindpunt.
PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.
PublicNetworkAccess	Of toegang tot openbare eindpunten al dan niet is toegestaan voor deze API Management-service. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als deze optie is uitgeschakeld, zijn privé-eindpunten de exclusieve toegangsmethode. De standaardwaarde is Ingeschakeld
ReleaseChannel	Releasekanaal van deze API Management-service.
RemotePrivateEndpointConnectionWrapper	Bron voor verbinding met extern privé-eindpunt.
SkuType	Naam van de SKU.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
UserIdentityProperties
VirtualNetworkConfiguration	Configuratie van een virtueel netwerk waarop de API Management-service is geïmplementeerd.
VirtualNetworkType	Het type VPN waarin de API Management-gateway moet worden geconfigureerd.

AdditionalLocation

Object

Beschrijving van een extra API Management-resourcelocatie.

Name	Type	Default value	Description
disableGateway	boolean	False	Eigenschap alleen geldig voor een Api Management-service die op meerdere locaties is geïmplementeerd. Dit kan worden gebruikt om de gateway op deze extra locatie uit te schakelen.
gatewayRegionalUrl	string		Gateway-URL van de API Management-service in de regio.
location	string		De locatienaam van de extra regio tussen Azure Data Center-regio's.
natGatewayState	NatGatewayState	Disabled	Eigenschap kan worden gebruikt om NAT Gateway in te schakelen voor deze API Management-service.
outboundPublicIPAddresses	string[]		Voorvoegsels voor uitgaande openbare IPV4-adressen die zijn gekoppeld aan de geïmplementeerde service van NAT Gateway. Alleen beschikbaar voor Premium SKU op het stv2-platform.
platformVersion	PlatformVersion		Compute Platform Versie waarop de service wordt uitgevoerd.
privateIPAddresses	string[]		Private Static Load Balanced IP-adressen van de API Management-service die wordt geïmplementeerd in een intern virtueel netwerk op een bepaalde extra locatie. Alleen beschikbaar voor Basic, Standard, Premium en Isolated SKU.
publicIPAddresses	string[]		Openbare statische taakverdeling IP-adressen van de API Management-service op de extra locatie. Alleen beschikbaar voor Basic, Standard, Premium en Isolated SKU.
publicIpAddressId	string		IP-adres op basis van Public Standard SKU V4 dat moet worden gekoppeld aan de geïmplementeerde service van Virtual Network op de locatie. Alleen ondersteund voor Premium-SKU die wordt geïmplementeerd in Virtual Network.
sku	ApiManagementServiceSkuProperties		SKU-eigenschappen van de API Management-service.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Configuratie van virtueel netwerk voor de locatie.
zones	string[]		Een lijst met beschikbaarheidszones die aangeeft waar de resource vandaan moet komen.

ApiManagementServiceIdentity

Object

Identiteitseigenschappen van de Api Management-serviceresource.

Name	Type	Description
principalId	string (uuid)	De principal-id van de identiteit.
tenantId	string (uuid)	De tenant-id van de client van de identiteit.
type	ApimIdentityType	Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.
userAssignedIdentities	<string, UserIdentityProperties>	De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

ApiManagementServiceResource

Object

Eén API Management-serviceresource in Lijst of Antwoord ophalen.

Name	Type	Default value	Description
etag	string		ETag van de resource.
id	string		Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ApiManagementServiceIdentity		Beheerde service-identiteit van de Api Management-service.
location	string		De geografische locatie waar de resource zich bevindt
name	string		De naam van de resource
properties.additionalLocations	AdditionalLocation[]		Aanvullende datacenterlocaties van de API Management-service.
properties.apiVersionConstraint	ApiVersionConstraint		Versiebeperking van Control Plane Apis voor de API Management-service.
properties.certificates	CertificateConfiguration[]		Lijst met certificaten die moeten worden geïnstalleerd in de API Management-service. Het maximum aantal ondersteunde certificaten dat kan worden geïnstalleerd, is 10.
properties.configurationApi	ConfigurationApi		Configuratie-API-configuratie van de API Management-service.
properties.createdAtUtc	string (date-time)		Aanmaak UTC-datum van de API Management-service. De datum komt overeen met het volgende formaat: `yyyy-MM-ddTHH:mm:ssZ` zoals gespecificeerd door de ISO 8601-norm.
properties.customProperties	object		Aangepaste eigenschappen van de API Management-service. Met deze instelling `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` wordt de TLS_RSA_WITH_3DES_EDE_CBC_SHA voor alle TLS(1.0, 1.1 en 1.2) uitgeschakeld. De instelling `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` kan worden gebruikt om alleen TLS 1.1 uit te schakelen. De instelling `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` kan worden gebruikt om TLS 1.0 uit te schakelen op een API-beheerservice. De instelling `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` kan worden gebruikt om alleen TLS 1.1 uit te schakelen voor communicatie met backends. Deze instelling `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` kan worden gebruikt om TLS 1.0 uit te schakelen voor communicatie met back-ends. De instelling `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` kan worden gebruikt om het HTTP2-protocol in te schakelen op een API-beheerservice. Als u geen van deze eigenschappen opgeeft bij de PATCH-bewerking, worden de waarden van weggelaten eigenschappen teruggezet naar de standaardwaarden. Voor alle instellingen behalve Http2 is `True` de standaardwaarde als de service op of vóór 1 april 2018 en `False` anderszins is gemaakt. De standaardwaarde van de Http2-instelling is `False`. U kunt elk van de volgende cijfers uitschakelen met behulp van de instellingen `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. Bijvoorbeeld: `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. De standaardwaarde is `true` voor hen. Opmerking: De volgende cijfers kunnen niet worden uitgeschakeld omdat ze vereist zijn voor interne platformonderdelen: 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	Status van de ontwikkelaarsportal in deze API Management-service.
properties.developerPortalUrl	string		DEveloper Portal-eindpunt-URL van de API Management-service.
properties.disableGateway	boolean	False	Eigenschap alleen geldig voor een Api Management-service die op meerdere locaties is geïmplementeerd. Dit kan worden gebruikt om de gateway in de hoofdregio uit te schakelen.
properties.enableClientCertificate	boolean	False	De eigenschap is alleen bedoeld om te worden gebruikt voor de verbruiks-SKU-service. Hiermee wordt afgedwongen dat een clientcertificaat wordt weergegeven bij elke aanvraag voor de gateway. Hiermee kunt u ook het certificaat verifiëren in het beleid op de gateway.
properties.gatewayRegionalUrl	string		Gateway-URL van de API-beheerservice in de standaardregio.
properties.gatewayUrl	string		Gateway-URL van de API Management-service.
properties.hostnameConfigurations	HostnameConfiguration[]		Aangepaste hostnaamconfiguratie van de API Management-service.
properties.legacyPortalStatus	LegacyPortalStatus	Enabled	Status van de verouderde portal in de API Management-service.
properties.managementApiUrl	string		URL van het eindpunt van de API-beheerservice voor beheer.
properties.natGatewayState	NatGatewayState	Disabled	Eigenschap kan worden gebruikt om NAT Gateway in te schakelen voor deze API Management-service.
properties.notificationSenderEmail	string maxLength: 100		E-mailadres van waaruit de melding wordt verzonden.
properties.outboundPublicIPAddresses	string[]		Voorvoegsels voor uitgaande openbare IPV4-adressen die zijn gekoppeld aan de geïmplementeerde service van NAT Gateway. Alleen beschikbaar voor Premium SKU op het stv2-platform.
properties.platformVersion	PlatformVersion		Compute Platform Versie waarop de service op deze locatie wordt uitgevoerd.
properties.portalUrl	string		Eindpunt van de uitgeverportal Url van de API Management-service.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Lijst met Private Endpoint-verbindingen van deze service.
properties.privateIPAddresses	string[]		Privé statisch taakverdeling IP-adressen van de API Management-service in de primaire regio die is geïmplementeerd in een intern virtueel netwerk. Alleen beschikbaar voor Basic, Standard, Premium en Isolated SKU.
properties.provisioningState	string		De huidige inrichtingsstatus van de API-beheerservice, die een van de volgende kan zijn: Gemaakt/Activeren/Geslaagd/Bijwerken/Mislukt/Gestopt/Beëindigen/BeëindigingMislukt/Verwijderd.
properties.publicIPAddresses	string[]		Openbare statische IP-adressen met taakverdeling van de API-beheerservice in de primaire regio. Alleen beschikbaar voor Basic, Standard, Premium en Isolated SKU.
properties.publicIpAddressId	string		IP-adres op basis van openbare standaard-SKU V4 dat moet worden gekoppeld aan de geïmplementeerde service van het virtuele netwerk in de regio. Alleen ondersteund voor Developer en Premium SKU die worden geïmplementeerd in Virtual Network.
properties.publicNetworkAccess	PublicNetworkAccess		Of toegang tot openbare eindpunten al dan niet is toegestaan voor deze API Management-service. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als deze optie is uitgeschakeld, zijn privé-eindpunten de exclusieve toegangsmethode. De standaardwaarde is Ingeschakeld
properties.publisherEmail	string maxLength: 100		E-mail van Publisher.
properties.publisherName	string maxLength: 100		Naam van uitgever.
properties.releaseChannel	ReleaseChannel		Releasekanaal van deze API Management-service.
properties.restore	boolean	False	Maak de verwijdering van de Api Management Service ongedaan als deze eerder voorlopig is verwijderd. Als deze vlag is opgegeven en op Waar is ingesteld, worden alle andere eigenschappen genegeerd.
properties.scmUrl	string		SCM-eindpunt-URL van de API Management-service.
properties.targetProvisioningState	string		De inrichtingsstatus van de API Management-service, die wordt beoogd door de langlopende bewerking die op de service is gestart.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Configuratie van virtueel netwerk van de API Management-service.
properties.virtualNetworkType	VirtualNetworkType	None	Het type VPN waarin de API Management-service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een virtueel netwerk, extern betekent dat de API Management-implementatie is ingesteld binnen een virtueel netwerk met een internetgericht eindpunt en intern betekent dat de API Management-implementatie alleen is ingesteld in een virtueel netwerk met alleen een intranetgericht eindpunt.
properties.zoneRedundant	boolean	False	Zoneredundante vereiste bij het maken van StandardV2 en PremiumV2. Als deze vlag op Waar is gezet, zal deze een APIM-dienst met Zone-redundant teruggeven of het verzoek mislukken als een onderliggende component niet zone-redundant kan zijn.
sku	ApiManagementServiceSkuProperties		SKU-eigenschappen van de API Management-service.
systemData	systemData		Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags	object		Resourcetags.
type	string		Het type bron. Bijv. "Microsoft.Compute/virtualMachines" of "Microsoft.Storage/storageAccounts"
zones	string[]		De beschikbaarheidszones.

ApiManagementServiceSkuProperties

Object

SKU-eigenschappen van API Management-serviceresource.

Name	Type	Description
capacity	integer (int32)	Capaciteit van de SKU (aantal geïmplementeerde eenheden van de SKU). Voor verbruik moet de SKU-capaciteit worden opgegeven als 0.
name	SkuType	Naam van de SKU.

ApimIdentityType

Opsomming

Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.

Waarde	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ApiVersionConstraint

Object

Versiebeperking van Control Plane Apis voor de API Management-service.

Name	Type	Description
minApiVersion	string	Beperk API-aanroepen van het besturingsvlak tot de API Management-service met een versie die gelijk is aan of nieuwer is dan deze waarde.

ArmIdWrapper

Object

Een wrapper voor een ARM-resource-id

Name	Type	Description
id	string

CertificateConfiguration

Object

Certificaatconfiguratie die bestaat uit niet-vertrouwde tussenproducten en basiscertificaten.

Name	Type	Description
certificate	CertificateInformation	Certificaatgegevens.
certificatePassword	string	Certificaatwachtwoord.
encodedCertificate	string	Base64 Gecodeerd certificaat.
storeName	CertificateConfigurationStoreName	De locatie van het certificaatarchief System.Security.Cryptography.x509certificates.StoreName. Alleen root en CertificateAuthority zijn geldige locaties.

CertificateConfigurationStoreName

Opsomming

De locatie van het certificaatarchief System.Security.Cryptography.x509certificates.StoreName. Alleen root en CertificateAuthority zijn geldige locaties.

Waarde	Description
CertificateAuthority
Root

CertificateInformation

Object

Informatie over SSL-certificaten.

Name	Type	Description
expiry	string (date-time)	Vervaldatum van het certificaat. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
subject	string	Onderwerp van het certificaat.
thumbprint	string	Vingerafdruk van het certificaat.

CertificateSource

Opsomming

Bron certificaat.

Waarde	Description
Managed
KeyVault
Custom
BuiltIn

CertificateStatus

Opsomming

Status van het certificaat.

Waarde	Description
Completed
Failed
InProgress

ConfigurationApi

Object

Informatie over de configuratie-API van de API Management-service.

Name	Type	Default value	Description
legacyApi	LegacyApiState	Enabled	Indicatie of de verouderde configuratie-API (v1) al dan niet moet worden weergegeven op de API Management-service. De waarde is optioneel, maar moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als 'Uitgeschakeld', is de verouderde configuratie-API (v1) niet beschikbaar voor zelf-hostende gateways. De standaardwaarde is Ingeschakeld

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

DeveloperPortalStatus

Opsomming

Status van de ontwikkelaarsportal in deze API Management-service.

Waarde	Description
Enabled	Developer Portal is ingeschakeld voor de service.
Disabled	Developer Portal is uitgeschakeld voor de service.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

HostnameConfiguration

Object

Aangepaste hostnaamconfiguratie.

Name	Type	Default value	Description
certificate	CertificateInformation		Certificaatgegevens.
certificatePassword	string		Certificaatwachtwoord.
certificateSource	CertificateSource		Bron certificaat.
certificateStatus	CertificateStatus		Status van het certificaat.
defaultSslBinding	boolean	False	Geef true op voor het instellen van het certificaat dat is gekoppeld aan deze hostnaam als het standaard-SSL-certificaat. Als een client de SNI-header niet verzendt, wordt dit het certificaat dat wordt aangeroepen. De eigenschap is handig als voor een service meerdere aangepaste hostnaam is ingeschakeld en moet worden bepaald welk standaard-SSL-certificaat moet worden gebruikt. De instelling was alleen van toepassing op het hostnaamtype van de gateway.
encodedCertificate	string		Base64 Gecodeerd certificaat.
hostName	string		Hostnaam die moet worden geconfigureerd voor de Api Management-service.
identityClientId	string		Systeem of door de gebruiker toegewezen beheerde identiteit clientId zoals gegenereerd door Azure AD, die GET-toegang heeft tot de keyVault die het SSL-certificaat bevat.
keyVaultId	string		Url naar het KeyVault-geheim met het SSL-certificaat. Als er een absolute URL met versie wordt opgegeven, werkt automatisch bijwerken van ssl-certificaat niet. Hiervoor moet de Api Management-service worden geconfigureerd met aka.ms/apimmsi. Het geheim moet van het type application/x-pkcs12
negotiateClientCertificate	boolean	False	Geef waar op om altijd te onderhandelen over clientcertificaat op de hostnaam. De standaardwaarde is onwaar.
type	HostnameType		Type hostnaam.

HostnameType

Opsomming

Type hostnaam.

Waarde	Description
Proxy
Portal
Management
Scm
DeveloperPortal
ConfigurationApi

LegacyApiState

Opsomming

Indicatie of de verouderde configuratie-API (v1) al dan niet moet worden weergegeven op de API Management-service. De waarde is optioneel, maar moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als 'Uitgeschakeld', is de verouderde configuratie-API (v1) niet beschikbaar voor zelf-hostende gateways. De standaardwaarde is Ingeschakeld

Waarde	Description
Enabled	Legacy Configuration API (v1) is ingeschakeld voor de service en zelf-hostende gateways kunnen er verbinding mee maken.
Disabled	Legacy Configuration API (v1) is uitgeschakeld voor de service en zelf-hostende gateways kunnen er geen verbinding mee maken.

LegacyPortalStatus

Opsomming

Status van de verouderde portal in de API Management-service.

Waarde	Description
Enabled	Legacy Portal is ingeschakeld voor de service.
Disabled	Legacy Portal is uitgeschakeld voor de service.

NatGatewayState

Opsomming

Eigenschap kan worden gebruikt om NAT Gateway in te schakelen voor deze API Management-service.

Waarde	Description
Enabled	Nat Gateway is ingeschakeld voor de service.
Disabled	Nat Gateway is uitgeschakeld voor de service.

PlatformVersion

Opsomming

Compute Platform Versie waarop de service wordt uitgevoerd.

Waarde	Description
undetermined	De versie van het platform kan niet worden bepaald, omdat het rekenplatform niet is geïmplementeerd.
stv1	Platform waarop de service wordt uitgevoerd op het Single Tenant V1-platform.
stv2	Platform waarop de service wordt uitgevoerd op het Single Tenant V2-platform.
mtv1	Platform waarop de service wordt uitgevoerd op het Multi Tenant V1-platform.
stv2.1	Platform waarop de service wordt uitgevoerd op het Single Tenant V2-platform op nieuwere hardware.

PrivateEndpointServiceConnectionStatus

Opsomming

De verbindingsstatus van het privé-eindpunt.

Waarde	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Object

Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.

Name	Type	Description
actionsRequired	string	Een bericht dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen.
description	string	De reden voor goedkeuring/afwijzing van de verbinding.
status	PrivateEndpointServiceConnectionStatus	Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service.

PublicNetworkAccess

Opsomming

Of toegang tot openbare eindpunten al dan niet is toegestaan voor deze API Management-service. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als deze optie is uitgeschakeld, zijn privé-eindpunten de exclusieve toegangsmethode. De standaardwaarde is Ingeschakeld

Waarde	Description
Enabled
Disabled

ReleaseChannel

Opsomming

Releasekanaal van deze API Management-service.

Waarde	Description
Preview	Voorbeeldkanaal van de service.
Default	Standaardkanaal van de service.
Stable	Stabiel kanaal van de dienst.

RemotePrivateEndpointConnectionWrapper

Object

Bron voor verbinding met extern privé-eindpunt.

Name	Type	Description
id	string	Bron-id van verbinding met privé-eindpunt
name	string	Naam van verbinding met privé-eindpunt
properties.groupIds	string[]	Alle groeps-id's.
properties.privateEndpoint	ArmIdWrapper	De resource van het privé-eindpunt.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.
properties.provisioningState	string	De inrichtingsstatus van de privé-eindpuntverbindingsresource.
type	string	Resourcetype voor verbinding met privé-eindpunt

SkuType

Opsomming

Naam van de SKU.

Waarde	Description
Developer	Ontwikkelaar SKU van Api Management.
Standard	Standaard SKU van Api Management.
Premium	Premium SKU van Api-beheer.
Basic	Basis-SKU van API-beheer.
Consumption	Verbruiks-SKU van Api-beheer.
Isolated	Geïsoleerde SKU van API-beheer.
BasicV2	BasicV2 SKU van Api Management.
StandardV2	StandardV2 SKU van Api-beheer.
PremiumV2	PremiumV2 SKU van Api Management.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

UserIdentityProperties

Object

Name	Type	Description
clientId	string	De client-id van de door de gebruiker toegewezen identiteit.
principalId	string	De principal-id van de door de gebruiker toegewezen identiteit.

VirtualNetworkConfiguration

Object

Configuratie van een virtueel netwerk waarop de API Management-service is geïmplementeerd.

Name	Type	Description
subnetResourceId	string pattern: ^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$	De volledige resource-id van een subnet in een virtueel netwerk waarin de API Management-service wordt geïmplementeerd.
subnetname	string	De naam van het subnet.
vnetid	string	De id van het virtuele netwerk. Dit is meestal een GUID. Verwacht standaard een null-GUID.

VirtualNetworkType

Opsomming

Het type VPN waarin de API Management-gateway moet worden geconfigureerd.

Waarde	Description
None	De API Management-gateway maakt geen deel uit van een virtueel netwerk.
External	De API Management-gateway maakt deel uit van Virtual Network en is toegankelijk via internet.
Internal	De API Management-gateway maakt deel uit van Virtual Network en is alleen toegankelijk vanuit het virtuele netwerk.

Delen via

Api Management Service - Refresh Hostnames

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiManagementServiceRefreshKeyVaultHostnames

Voorbeeldaanvraag

Voorbeeldrespons

Definities

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