Condividi tramite

Api Management Service - Get

  • Riferimento
Service:
API Management
API Version:
2022-08-01

Ottiene una descrizione della risorsa del servizio Gestione API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}?api-version=2022-08-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
 path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
serviceName
 path True

string

Nome del servizio Gestione API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

ID della sottoscrizione di destinazione.
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

ApiManagementServiceResource

È stata ottenuta correttamente la risorsa del servizio Gestione API.
Other Status Codes

ErrorResponse

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

ApiManagementServiceGetMultiRegionInternalVnet
ApiManagementServiceGetService
ApiManagementServiceGetServiceHavingMsi

ApiManagementServiceGetMultiRegionInternalVnet

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1",
  "name": "apimservice1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {},
  "location": "West US",
  "etag": "AAAAAADqC0c=",
  "properties": {
    "publisherEmail": "abcs@contoso.com",
    "publisherName": "contoso publisher",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-02T01:42:09.1268424Z",
    "gatewayUrl": "https://apimservice1.azure-api.net",
    "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net",
    "portalUrl": "https://apimservice1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimservice1.management.azure-api.net",
    "scmUrl": "https://apimservice1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "apimgatewaytest.preview.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2019-08-16T16:51:34+00:00",
          "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476",
          "subject": "CN=*.preview.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "Custom"
      }
    ],
    "publicIPAddresses": [
      "137.XXX.11.74"
    ],
    "privateIPAddresses": [
      "172.XX.0.5"
    ],
    "additionalLocations": [
      {
        "location": "West US 2",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "40.XXX.79.187"
        ],
        "privateIPAddresses": [
          "10.0.X.6"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub"
        },
        "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net",
        "disableGateway": false
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False"
    },
    "virtualNetworkType": "Internal",
    "disableGateway": false,
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

ApiManagementServiceGetService

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium",
  "name": "OGF-Z3-06162021-Premium",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "owner": "v-aswmoh",
    "ReleaseName": "Z3"
  },
  "location": "East US",
  "etag": "AAAAAAAWN/4=",
  "properties": {
    "publisherEmail": "string",
    "publisherName": "Test Premium",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2021-06-16T09:40:00.9453556Z",
    "gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net",
    "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net",
    "portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net",
    "developerPortalUrl": "https://ogf-z3-06162021-premium.developer.azure-api.net",
    "managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net",
    "scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "ogf-z3-06162021-premium.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "gateway.current.int-azure-api.net",
        "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl",
        "negotiateClientCertificate": true,
        "certificate": {
          "expiry": "2022-01-08T22:32:32+00:00",
          "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51",
          "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"
        },
        "defaultSslBinding": true,
        "certificateSource": "Custom"
      },
      {
        "type": "DeveloperPortal",
        "hostName": "developer.current.int-azure-api.net",
        "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2022-01-08T22:32:32+00:00",
          "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51",
          "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"
        },
        "defaultSslBinding": false,
        "certificateSource": "Custom"
      },
      {
        "type": "Management",
        "hostName": "mgmt.current.int-azure-api.net",
        "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2022-01-08T22:32:32+00:00",
          "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51",
          "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"
        },
        "defaultSslBinding": false,
        "certificateSource": "Custom"
      }
    ],
    "publicIPAddresses": [
      "13.92.130.49"
    ],
    "additionalLocations": [
      {
        "location": "East US 2",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "zones": [],
        "publicIPAddresses": [
          "40.70.24.106"
        ],
        "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net",
        "disableGateway": false,
        "platformVersion": "stv2"
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false"
    },
    "virtualNetworkType": "None",
    "certificates": [],
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-12-01"
    },
    "publicNetworkAccess": "Enabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName",
        "type": "Microsoft.ApiManagement/service/privateEndpointConnections",
        "name": "privateEndpointProxyName",
        "properties": {
          "provisioningState": "Pending",
          "privateEndpoint": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
          },
          "privateLinkServiceConnectionState": {
            "status": "Pending",
            "description": "Please approve my request, thanks",
            "actionsRequired": "None"
          },
          "groupIds": [
            "Gateway"
          ]
        }
      }
    ],
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "306205e7-b21a-41bf-92e2-3e28af30041e",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": {
        "principalId": "713784d2-ee37-412a-95f0-3768f397f82d",
        "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789"
      }
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2021-06-16T09:40:00.7106733Z",
    "lastModifiedBy": "foo@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-20T06:33:09.6159006Z"
  }
}

ApiManagementServiceGetServiceHavingMsi

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {},
  "location": "West Europe",
  "etag": "AAAAAAAENfI=",
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "Contoso",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2016-04-12T00:20:15.6018952Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-westeurope-01.regional.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "proxy.msitesting.net",
        "keyVaultId": "https://samir-msi-keyvault.vault.azure.net/secrets/msicertificate",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2020-12-18T11:11:47+00:00",
          "thumbprint": "9833D531D7A45XXXXXA85908BD3692E0BD3F",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "KeyVault"
      }
    ],
    "publicIPAddresses": [
      "13.94.xxx.188"
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "External",
    "disableGateway": false
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "ca1d33f7-0000-42ec-0000-d526a1ee953a",
    "tenantId": "72f988bf-0000-41af-0000-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {
        "principalId": "95194df2-9208-0000-0000-a10d2af9b5a3",
        "clientId": "aaff9c7d-0000-4db2-0000-ab0e3e7806cf"
      }
    }
  }
}

Definizioni

Nome Descrizione
AdditionalLocation

Descrizione di un percorso di risorse aggiuntivo Gestione API.
ApiManagementServiceIdentity

Proprietà di identità della risorsa del servizio Gestione API.
ApiManagementServiceResource

Una singola risorsa del servizio Gestione API in Elenco o Recupera risposta.
ApiManagementServiceSkuProperties

Gestione API proprietà SKU delle risorse del servizio.
ApimIdentityType

Tipo di identità utilizzata per la risorsa. Il tipo 'SystemAssigned, UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'Nessuno' rimuoverà le identità dal servizio.
ApiVersionConstraint

Vincolo di versione api piano di controllo per il servizio Gestione API.
ArmIdWrapper

Wrapper per un ID risorsa ARM
CertificateConfiguration

Configurazione del certificato costituita da intermedi non attendibili e certificati radice.
CertificateInformation

Informazioni sul certificato SSL.
CertificateSource

Origine certificati.
CertificateStatus

Stato certificato.
createdByType

Tipo di identità che ha creato la risorsa.
ErrorFieldContract

Contratto campo errore.
ErrorResponse

Risposta errore.
HostnameConfiguration

Configurazione personalizzata del nome host.
HostnameType

Tipo hostname.
NatGatewayState

La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API.
PlatformVersion

Versione della piattaforma di calcolo che esegue il servizio.
PrivateEndpointServiceConnectionStatus

Stato di connessione dell'endpoint privato.
PrivateLinkServiceConnectionState

Raccolta di informazioni sullo stato della connessione tra il consumer del servizio e il provider.
PublicNetworkAccess

Se l'accesso all'endpoint pubblico è consentito per questo servizio di Gestione API. Il valore è facoltativo, ma se passato, deve essere "Abilitato" o "Disabilitato". Se "Disabilitato", gli endpoint privati sono il metodo di accesso esclusivo. Il valore predefinito è 'Enabled'
RemotePrivateEndpointConnectionWrapper

Risorsa Connessione endpoint privato remoto.
SkuType

Nome dello Sku.
systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.
UserIdentityProperties
VirtualNetworkConfiguration

Configurazione di una rete virtuale in cui viene distribuito Gestione API servizio.
VirtualNetworkType

Tipo di VPN in cui è necessario configurare Gestione API servizio. Nessuna (valore predefinito) indica che il servizio Gestione API non fa parte di alcun Rete virtuale, external significa che la distribuzione Gestione API viene configurata all'interno di un Rete virtuale che ha un endpoint con connessione Internet e che la distribuzione interna Gestione API è configurata all'interno di un Rete virtuale solo un endpoint con connessione Intranet.

AdditionalLocation

Descrizione di un percorso di risorse aggiuntivo Gestione API.

Nome Tipo Valore predefinito Descrizione
disableGateway

boolean

False

Proprietà valida solo per un servizio Gestione API distribuito in più posizioni. Questa operazione può essere usata per disabilitare il gateway in questa posizione aggiuntiva.
gatewayRegionalUrl

string

URL del gateway del servizio Gestione API nell'area.
location

string

Nome della posizione dell'area aggiuntiva tra le aree del data center di Azure.
natGatewayState

NatGatewayState

Disabled

La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API.
outboundPublicIPAddresses

string[]

Prefissi di indirizzi IPV4 pubblici in uscita associati al servizio distribuito dal gateway NAT. Disponibile solo per lo SKU Premium sulla piattaforma stv2.
platformVersion

PlatformVersion

Versione della piattaforma di calcolo che esegue il servizio.
privateIPAddresses

string[]

Indirizzi IP statici statici privati del servizio Gestione API distribuito in un Rete virtuale interno in una determinata posizione aggiuntiva. Disponibile solo per SKU Basic, Standard, Premium e Isolato.
publicIPAddresses

string[]

Indirizzi IP statici statici pubblici del servizio Gestione API nel percorso aggiuntivo. Disponibile solo per SKU Basic, Standard, Premium e Isolato.
publicIpAddressId

string

Indirizzo IP basato su SKU standard pubblico V4 da associare a Rete virtuale servizio distribuito nel percorso. Supportato solo per lo SKU Premium distribuito in Rete virtuale.
sku

ApiManagementServiceSkuProperties

Proprietà SKU del servizio Gestione API.
virtualNetworkConfiguration

VirtualNetworkConfiguration

Configurazione della rete virtuale per il percorso.
zones

string[]

Elenco delle zone di disponibilità che denonono dove deve venire la risorsa.

ApiManagementServiceIdentity

Proprietà di identità della risorsa del servizio Gestione API.

Nome Tipo Descrizione
principalId

string

ID principale dell'identità.
tenantId

string

ID tenant client dell'identità.
type

ApimIdentityType

Tipo di identità utilizzata per la risorsa. Il tipo 'SystemAssigned, UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'Nessuno' rimuoverà le identità dal servizio.
userAssignedIdentities

<string,  UserIdentityProperties>

Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel modulo: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Una singola risorsa del servizio Gestione API in Elenco o Recupera risposta.

Nome Tipo Valore predefinito Descrizione
etag

string

ETag della risorsa.
id

string

ID risorsa.
identity

ApiManagementServiceIdentity

Identità del servizio gestito del servizio Gestione API.
location

string

Percorso della risorsa.
name

string

Nome risorsa.
properties.additionalLocations

AdditionalLocation[]

Località del data center aggiuntive del servizio Gestione API.
properties.apiVersionConstraint

ApiVersionConstraint

Vincolo di versione api piano di controllo per il servizio Gestione API.
properties.certificates

CertificateConfiguration[]

Elenco di certificati che devono essere installati nel servizio Gestione API. Il numero massimo di certificati supportati che possono essere installati è 10.
properties.createdAtUtc

string

Data UTC di creazione del servizio Gestione API. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.
properties.customProperties

object

Proprietà personalizzate del servizio Gestione API.
L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 disabilita il TLS_RSA_WITH_3DES_EDE_CBC_SHA di crittografia per tutti i file TLS(1.0, 1.1 e 1.2).
L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 può essere usata per disabilitare solo TLS 1.1.
L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 può essere usata per disabilitare TLS 1.0 in un servizio di Gestione API.
L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 può essere usata per disabilitare solo TLS 1.1 per le comunicazioni con back-end.
L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 può essere usata per disabilitare TLS 1.0 per le comunicazioni con back-end.
L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 può essere usata per abilitare il protocollo HTTP2 in un servizio Gestione API.
Non specificando alcuna di queste proprietà nell'operazione PATCH, i valori delle proprietà verranno ripristinati nei valori predefiniti. Per tutte le impostazioni tranne Http2 il valore predefinito è True se il servizio è stato creato o prima del 1° aprile 2018 e False in caso contrario. Il valore predefinito dell'impostazione Http2 è False.

È possibile disabilitare una delle crittografia seguenti usando le impostazioni 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_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Ad esempio, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Il valore predefinito è true per loro.
Nota: le crittografia seguenti non possono essere disabilitate poiché sono necessarie dai componenti della piattaforma interna: 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.developerPortalUrl

string

URL dell'endpoint del portale DEveloper del servizio Gestione API.
properties.disableGateway

boolean

False

Proprietà valida solo per un servizio Gestione API distribuito in più posizioni. Questa operazione può essere usata per disabilitare il gateway nell'area master.
properties.enableClientCertificate

boolean

False

La proprietà deve essere usata solo per il servizio SKU di consumo. In questo modo viene applicato un certificato client da presentare in ogni richiesta al gateway. Ciò consente anche di autenticare il certificato nel criterio nel gateway.
properties.gatewayRegionalUrl

string

URL del gateway del servizio Gestione API nell'area predefinita.
properties.gatewayUrl

string

URL del gateway del servizio Gestione API.
properties.hostnameConfigurations

HostnameConfiguration[]

Configurazione personalizzata del nome host del servizio Gestione API.
properties.managementApiUrl

string

URL dell'endpoint API di gestione del servizio Gestione API.
properties.natGatewayState

NatGatewayState

Disabled

La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API.
properties.notificationSenderEmail

string

Email indirizzo da cui verrà inviata la notifica.
properties.outboundPublicIPAddresses

string[]

Prefissi di indirizzi IPV4 pubblici in uscita associati al servizio distribuito dal gateway NAT. Disponibile solo per lo SKU Premium sulla piattaforma stv2.
properties.platformVersion

PlatformVersion

Versione della piattaforma di calcolo che esegue il servizio in questa posizione.
properties.portalUrl

string

Url dell'endpoint del portale di pubblicazione del servizio Gestione API.
properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

Elenco delle connessioni endpoint private di questo servizio.
properties.privateIPAddresses

string[]

Indirizzi IP statici statici privati del servizio Gestione API nell'area primaria distribuita in un Rete virtuale interno. Disponibile solo per SKU Basic, Standard, Premium e Isolato.
properties.provisioningState

string

Lo stato di provisioning corrente del servizio Gestione API che può essere uno dei seguenti: Creato/Attivazione/Aggiornamento/Aggiornamento/Non riuscito/Terminazione/TerminazioneFailed/Eliminato.
properties.publicIPAddresses

string[]

Indirizzi IP statici statici del servizio Gestione API nell'area primaria. Disponibile solo per SKU Basic, Standard, Premium e Isolato.
properties.publicIpAddressId

string

Indirizzo IP basato su SKU standard pubblico V4 da associare a Rete virtuale servizio distribuito nell'area. Supportato solo per lo SKU Developer e Premium distribuito in Rete virtuale.
properties.publicNetworkAccess

PublicNetworkAccess

Se l'accesso all'endpoint pubblico è consentito per questo servizio di Gestione API. Il valore è facoltativo, ma se passato, deve essere "Abilitato" o "Disabilitato". Se "Disabilitato", gli endpoint privati sono il metodo di accesso esclusivo. Il valore predefinito è 'Enabled'
properties.publisherEmail

string

Posta elettronica del server di pubblicazione.
properties.publisherName

string

Nome del server di pubblicazione.
properties.restore

boolean

False

Annullare l'eliminazione temporanea del servizio Gestione API. Se questo flag viene specificato e impostato su True tutte le altre proprietà verranno ignorate.
properties.scmUrl

string

URL dell'endpoint SCM del servizio Gestione API.
properties.targetProvisioningState

string

Stato di provisioning del servizio Gestione API, destinato all'operazione a esecuzione prolungata avviata nel servizio.
properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

Configurazione della rete virtuale del servizio di Gestione API.
properties.virtualNetworkType

VirtualNetworkType

None

Tipo di VPN in cui è necessario configurare Gestione API servizio. Nessuna (valore predefinito) indica che il servizio Gestione API non fa parte di alcun Rete virtuale, external significa che la distribuzione Gestione API viene configurata all'interno di un Rete virtuale che ha un endpoint con connessione Internet e che la distribuzione interna Gestione API è configurata all'interno di un Rete virtuale solo un endpoint con connessione Intranet.
sku

ApiManagementServiceSkuProperties

Proprietà SKU del servizio Gestione API.
systemData

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.
tags

object

Tag di risorse.
type

string

Il tipo di risorsa per Gestione API risorsa è impostato su Microsoft.ApiManagement.
zones

string[]

Elenco delle zone di disponibilità che denonono dove deve venire la risorsa.

ApiManagementServiceSkuProperties

Gestione API proprietà SKU delle risorse del servizio.

Nome Tipo Descrizione
capacity

integer

Capacità dello SKU (numero di unità distribuite dello SKU). Per la capacità SKU consumo deve essere specificato come 0.
name

SkuType

Nome dello Sku.

ApimIdentityType

Tipo di identità utilizzata per la risorsa. Il tipo 'SystemAssigned, UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'Nessuno' rimuoverà le identità dal servizio.

Nome Tipo Descrizione
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ApiVersionConstraint

Vincolo di versione api piano di controllo per il servizio Gestione API.

Nome Tipo Descrizione
minApiVersion

string

Limitare le chiamate API del piano di controllo a Gestione API servizio con versione uguale o successiva a questo valore.

ArmIdWrapper

Wrapper per un ID risorsa ARM

Nome Tipo Descrizione
id

string

CertificateConfiguration

Configurazione del certificato costituita da intermedi non attendibili e certificati radice.

Nome Tipo Descrizione
certificate

CertificateInformation

Informazioni sul certificato.
certificatePassword

string

Password del certificato.
encodedCertificate

string

Certificato codificato base64.
storeName enum:
  • CertificateAuthority
  • Root

Percorso dell'archivio certificati System.Security.Cryptography.x509certificates.StoreName. Solo Root e CertificateAuthority sono posizioni valide.

CertificateInformation

Informazioni sul certificato SSL.

Nome Tipo Descrizione
expiry

string

Data di scadenza del certificato. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.
subject

string

Oggetto del certificato.
thumbprint

string

Identificazione personale del certificato.

CertificateSource

Origine certificati.

Nome Tipo Descrizione
BuiltIn

string

Custom

string

KeyVault

string

Managed

string

CertificateStatus

Stato certificato.

Nome Tipo Descrizione
Completed

string

Failed

string

InProgress

string

createdByType

Tipo di identità che ha creato la risorsa.

Nome Tipo Descrizione
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorFieldContract

Contratto campo errore.

Nome Tipo Descrizione
code

string

Codice di errore a livello di proprietà.
message

string

Rappresentazione leggibile dell'errore a livello di proprietà.
target

string

Nome della proprietà.

ErrorResponse

Risposta errore.

Nome Tipo Descrizione
error.code

string

Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.
error.details

ErrorFieldContract[]

Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
error.message

string

Rappresentazione leggibile dell'errore.

HostnameConfiguration

Configurazione personalizzata del nome host.

Nome Tipo Valore predefinito Descrizione
certificate

CertificateInformation

Informazioni sul certificato.
certificatePassword

string

Password del certificato.
certificateSource

CertificateSource

Origine certificati.
certificateStatus

CertificateStatus

Stato certificato.
defaultSslBinding

boolean

False

Specificare true per configurare il certificato associato a questo nome host come certificato SSL predefinito. Se un client non invia l'intestazione SNI, questo sarà il certificato che verrà contestato. La proprietà è utile se un servizio dispone di più nomi host personalizzati abilitati e deve decidere sul certificato ssl predefinito. L'impostazione applicata solo al tipo host del gateway.
encodedCertificate

string

Certificato codificato base64.
hostName

string

Nome host da configurare nel servizio Gestione API.
identityClientId

string

Client dell'identità gestita assegnata dall'utente o del sistema come generato da Azure AD, che ha accesso GET alla chiaveVault contenente il certificato SSL.
keyVaultId

string

Url del segreto KeyVault contenente il certificato SSL. Se viene fornito l'URL assoluto contenente la versione, l'aggiornamento automatico del certificato ssl non funzionerà. Ciò richiede la configurazione del servizio Gestione API con aka.ms/apimmsi. Il segreto deve essere di tipo application/x-pkcs12
negotiateClientCertificate

boolean

False

Specificare true per negoziare sempre il certificato client nel nome host. Valore predefinito è false.
type

HostnameType

Tipo hostname.

HostnameType

Tipo hostname.

Nome Tipo Descrizione
DeveloperPortal

string

Management

string

Portal

string

Proxy

string

Scm

string

NatGatewayState

La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API.

Nome Tipo Descrizione
Disabled

string

Nat Gateway è disabilitato per il servizio.
Enabled

string

Nat Gateway è abilitato per il servizio.

PlatformVersion

Versione della piattaforma di calcolo che esegue il servizio.

Nome Tipo Descrizione
mtv1

string

Piattaforma che esegue il servizio nella piattaforma Multi Tenant V1.
stv1

string

Piattaforma che esegue il servizio nella piattaforma V1 a tenant singolo.
stv2

string

Piattaforma che esegue il servizio nella piattaforma V2 a tenant singolo.
undetermined

string

Impossibile determinare la versione della piattaforma, poiché la piattaforma di calcolo non viene distribuita.

PrivateEndpointServiceConnectionStatus

Stato di connessione dell'endpoint privato.

Nome Tipo Descrizione
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Raccolta di informazioni sullo stato della connessione tra il consumer del servizio e il provider.

Nome Tipo Descrizione
actionsRequired

string

Messaggio che indica se le modifiche nel provider di servizi richiedono eventuali aggiornamenti nel consumer.
description

string

Motivo dell'approvazione/rifiuto della connessione.
status

PrivateEndpointServiceConnectionStatus

Indica se la connessione è stata approvata/rifiutata/rimossa dal proprietario del servizio.

PublicNetworkAccess

Se l'accesso all'endpoint pubblico è consentito per questo servizio di Gestione API. Il valore è facoltativo, ma se passato, deve essere "Abilitato" o "Disabilitato". Se "Disabilitato", gli endpoint privati sono il metodo di accesso esclusivo. Il valore predefinito è 'Enabled'

Nome Tipo Descrizione
Disabled

string

Enabled

string

RemotePrivateEndpointConnectionWrapper

Risorsa Connessione endpoint privato remoto.

Nome Tipo Descrizione
id

string

ID risorsa connessione endpoint privato
name

string

Nome connessione endpoint privato
properties.groupIds

string[]

Tutti gli ID gruppo.
properties.privateEndpoint

ArmIdWrapper

Risorsa del punto finale privato.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Raccolta di informazioni sullo stato della connessione tra il consumer del servizio e il provider.
properties.provisioningState

string

Stato di provisioning della risorsa di connessione dell'endpoint privato.
type

string

Tipo di risorsa connessione endpoint privato

SkuType

Nome dello Sku.

Nome Tipo Descrizione
Basic

string

SKU di base di Gestione API.
Consumption

string

SKU di utilizzo di Gestione API.
Developer

string

SKU per sviluppatori di Gestione API.
Isolated

string

SKU isolato di Gestione API.
Premium

string

SKU Premium di Gestione API.
Standard

string

SKU standard di Gestione API.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string

Timestamp della creazione di risorse (UTC).
createdBy

string

Identità che ha creato la risorsa.
createdByType

createdByType

Tipo di identità che ha creato la risorsa.
lastModifiedAt

string

Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy

string

Identità che ha modificato l'ultima risorsa.
lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima risorsa.

UserIdentityProperties

Nome Tipo Descrizione
clientId

string

ID client dell'identità assegnata dall'utente.
principalId

string

ID principale dell'identità assegnata dall'utente.

VirtualNetworkConfiguration

Configurazione di una rete virtuale in cui viene distribuito Gestione API servizio.

Nome Tipo Descrizione
subnetResourceId

string

ID risorsa completo di una subnet in una rete virtuale per distribuire il servizio Gestione API in.
subnetname

string

Nome della subnet.
vnetid

string

ID rete virtuale. Questo è in genere un GUID. Per impostazione predefinita, si prevede un GUID Null.

VirtualNetworkType

Tipo di VPN in cui è necessario configurare Gestione API servizio. Nessuna (valore predefinito) indica che il servizio Gestione API non fa parte di alcun Rete virtuale, external significa che la distribuzione Gestione API viene configurata all'interno di un Rete virtuale che ha un endpoint con connessione Internet e che la distribuzione interna Gestione API è configurata all'interno di un Rete virtuale solo un endpoint con connessione Intranet.

Nome Tipo Descrizione
External

string

Il servizio fa parte di Rete virtuale ed è accessibile da Internet.
Internal

string

Il servizio fa parte di Rete virtuale ed è accessibile solo dall'interno della rete virtuale.
None

string

Il servizio non fa parte di alcun Rete virtuale.