Api Management Service - Backup

Crea un backup del servizio Gestione API nell'account di Archiviazione di Azure specificato. Il completamento dell'operazione è a esecuzione prolungata e può richiedere alcuni minuti.

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

Parametri dell'URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nome del gruppo di risorse.

serviceName
path True
  • string

Nome del servizio di Gestione API.

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

subscriptionId
path True
  • string

Credenziali di sottoscrizione che identificano in modo univoco Microsoft Azure sottoscrizione. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.

api-version
query True
  • string

Versione dell'API da usare con la richiesta client.

Corpo della richiesta

Name Required Type Description
backupName True
  • string

Nome del file di backup da creare/recuperare.

containerName True
  • string

Nome del contenitore BLOB (usato per posizionare/recuperare il backup).

storageAccount True
  • string

Nome dell'account di archiviazione di Azure (usato per inserire/recuperare il backup).

accessKey
  • string

Chiave di accesso dell'account di archiviazione. Obbligatorio solo se accessType è impostato su AccessKey.

accessType

Tipo di accesso da usare per l'account di archiviazione.

clientId
  • string

ID client dell'identità gestita assegnata dall'utente. Obbligatorio solo se accessType è impostato su UserAssignedManagedIdentity.

Risposte

Name Type Description
200 OK

È stato eseguito il backup del servizio Gestione API nell'account di archiviazione.

202 Accepted

Accettato: l'intestazione Location contiene l'URL in cui è possibile controllare lo stato dell'operazione a esecuzione prolungata.

Other Status Codes

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name Description
user_impersonation rappresentare l'account utente

Esempio

ApiManagementBackupWithAccessKey
ApiManagementBackupWithSystemManagedIdentity
ApiManagementBackupWithUserAssignedManagedIdentity

ApiManagementBackupWithAccessKey

Sample Request

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

{
  "storageAccount": "teststorageaccount",
  "containerName": "backupContainer",
  "backupName": "apimService1backup_2017_03_19",
  "accessType": "AccessKey",
  "accessKey": "**************************************************"
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "West US",
  "etag": "AAAAAAACXok=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:26:20.3348609Z",
    "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
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "publicIPAddresses": [
      "13.91.32.113"
    ],
    "additionalLocations": [
      {
        "location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "23.101.138.153"
        ],
        "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net",
        "disableGateway": true
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

ApiManagementBackupWithSystemManagedIdentity

Sample Request

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

{
  "storageAccount": "contosorpstorage",
  "containerName": "apim-backups",
  "backupName": "backup5",
  "accessType": "SystemAssignedManagedIdentity"
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "apimService1"
  },
  "location": "Central US EUAP",
  "etag": "AAAAAAAQM8o=",
  "properties": {
    "publisherEmail": "apimService1@corp.microsoft.com",
    "publisherName": "MS",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-04-23T16:26:47.8637967Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centraluseuap-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": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "52.XXXX.160.66"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "XXXXX-5fb4-4916-95d4-64b306f9d924",
    "tenantId": "XXXXX-86f1-XXXXX-91ab-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
        "principalId": "XXXXX-a100-4478-XXXX-d65d98118ba0",
        "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
      },
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
        "principalId": "XXXXX-9208-4128-af2d-a10d2af9b5a3",
        "clientId": "XXXX-6328-4db2-XXXX-ab0e3e7806cf"
      }
    }
  },
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
  }
}

ApiManagementBackupWithUserAssignedManagedIdentity

Sample Request

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

{
  "storageAccount": "contosorpstorage",
  "containerName": "apim-backups",
  "backupName": "backup5",
  "accessType": "UserAssignedManagedIdentity",
  "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "apimService1"
  },
  "location": "Central US EUAP",
  "etag": "AAAAAAAQM8o=",
  "properties": {
    "publisherEmail": "apimService1@corp.microsoft.com",
    "publisherName": "MS",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-04-23T16:26:47.8637967Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centraluseuap-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": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "52.XXXX.160.66"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "XXXXX-5fb4-4916-95d4-64b306f9d924",
    "tenantId": "XXXXX-86f1-XXXXX-91ab-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
        "principalId": "XXXXX-a100-4478-XXXX-d65d98118ba0",
        "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
      },
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
        "principalId": "XXXXX-9208-4128-af2d-a10d2af9b5a3",
        "clientId": "XXXX-6328-4db2-XXXX-ab0e3e7806cf"
      }
    }
  },
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
  }
}

Definizioni

AccessType

Tipo di accesso da usare per l'account di archiviazione.

AdditionalLocation

Descrizione di un percorso aggiuntivo Gestione API risorsa.

ApiManagementServiceBackupRestoreParameters

Parametri forniti al Backup/ripristino di un'operazione del servizio Gestione API.

ApiManagementServiceIdentity

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

ApiManagementServiceResource

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

ApiManagementServiceSkuProperties

Gestione API proprietà sku della risorsa del servizio.

ApimIdentityType

Tipo di identità usata 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 del 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 certificato.

CertificateStatus

Stato certificato.

createdByType

Tipo di identità che ha creato la risorsa.

ErrorFieldContract

Contratto campo di errore.

ErrorResponse

Risposta errore.

HostnameConfiguration

Configurazione personalizzata del nome host.

HostnameType

Tipo nome host.

PlatformVersion

Versione della piattaforma di calcolo che esegue il servizio.

PrivateEndpointServiceConnectionStatus

Stato della connessione dell'endpoint privato.

PrivateLinkServiceConnectionState

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

PublicNetworkAccess

Indica se l'accesso all'endpoint pubblico è consentito per questo servizio Gestione API. Il valore è facoltativo, ma se passato, deve essere 'Enabled' o 'Disabled'. 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 Gestione API servizio deve essere configurato. Nessuno (valore predefinito) indica che il servizio Gestione API non fa parte di alcuna Rete virtuale, external indica che la distribuzione Gestione API è configurata all'interno di un Rete virtuale con un endpoint con connessione Internet e internal significa che Gestione API distribuzione è configurata all'interno di un Rete virtuale avere solo un endpoint con connessione Intranet.

AccessType

Tipo di accesso da usare per l'account di archiviazione.

Name Type Description
AccessKey
  • string

Usare la chiave di accesso.

SystemAssignedManagedIdentity
  • string

Usare l'identità gestita assegnata dal sistema.

UserAssignedManagedIdentity
  • string

Usare l'identità gestita assegnata dall'utente.

AdditionalLocation

Descrizione di un percorso aggiuntivo Gestione API risorsa.

Name Type Default Value Description
disableGateway
  • boolean
False

Proprietà valida solo per un servizio Gestione API distribuito in più posizioni. Può essere usato per disabilitare il gateway in questo percorso aggiuntivo.

gatewayRegionalUrl
  • string

URL del gateway del servizio Gestione API nell'area.

location
  • string

Nome della località dell'area aggiuntiva tra le aree del data center di Azure.

platformVersion

Versione della piattaforma di calcolo che esegue il servizio.

privateIPAddresses
  • string[]

Indirizzi IP con carico bilanciato statico privato del servizio Gestione API distribuito in un Rete virtuale interno in una determinata posizione aggiuntiva. Disponibile solo per lo SKU Basic, Standard, Premium e Isolato.

publicIPAddresses
  • string[]

Indirizzi IP statici statici con carico bilanciato pubblico del servizio Gestione API nella posizione aggiuntiva. Disponibile solo per lo SKU Basic, Standard, Premium e Isolato.

publicIpAddressId
  • string

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

sku

Proprietà SKU del servizio Gestione API.

virtualNetworkConfiguration

Configurazione della rete virtuale per il percorso.

zones
  • string[]

Elenco di zone di disponibilità che indicano da cui deve provenire la risorsa.

ApiManagementServiceBackupRestoreParameters

Parametri forniti al Backup/ripristino di un'operazione del servizio Gestione API.

Name Type Default Value Description
accessKey
  • string

Chiave di accesso dell'account di archiviazione. Obbligatorio solo se accessType è impostato su AccessKey.

accessType AccessKey

Tipo di accesso da usare per l'account di archiviazione.

backupName
  • string

Nome del file di backup da creare/recuperare.

clientId
  • string

ID client dell'identità gestita assegnata dall'utente. Obbligatorio solo se accessType è impostato su UserAssignedManagedIdentity.

containerName
  • string

Nome del contenitore BLOB (usato per posizionare/recuperare il backup).

storageAccount
  • string

Nome dell'account di archiviazione di Azure (usato per inserire/recuperare il backup).

ApiManagementServiceIdentity

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

Name Type Description
principalId
  • string

ID dell'entità dell'identità.

tenantId
  • string

ID tenant client dell'identità.

type

Tipo di identità usata 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

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

ApiManagementServiceResource

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

Name Type Default Value Description
etag
  • string

ETag della risorsa.

id
  • string

ID risorsa.

identity

Identità del servizio gestito del servizio Gestione API.

location
  • string

Percorso della risorsa.

name
  • string

Nome risorsa.

properties.additionalLocations

Località del data center aggiuntive del servizio Gestione API.

properties.apiVersionConstraint

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

properties.certificates

Elenco di certificati che devono essere installati nel servizio Gestione API. Il numero massimo di certificati supportati che è possibile installare è 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 protocolli 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.
Se non si specifica alcuna di queste proprietà nell'operazione PATCH, i valori delle proprietà verranno reimpostati sui valori predefiniti. Per tutte le impostazioni ad eccezione di Http2, il valore predefinito è True se il servizio è stato creato il 1° aprile 2018 e False in caso contrario. Il valore predefinito dell'impostazione Http2 è False.

È possibile disabilitare una delle crittografie successive 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_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 crittografie successive non possono essere disabilitate perché sono richieste dai componenti interni di Azure CloudService: 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,TLS_RSA_WITH_AES_256_GCM_SHA384

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. Può essere usato per disabilitare il gateway nell'area master.

properties.enableClientCertificate
  • boolean
False

La proprietà deve essere usata solo per il servizio SKU a consumo. In questo modo viene applicato un certificato client da presentare a ogni richiesta al gateway. In questo modo è anche possibile autenticare il certificato nei criteri 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

Configurazione personalizzata del nome host del servizio di Gestione API.

properties.managementApiUrl
  • string

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

properties.notificationSenderEmail
  • string

Indirizzo di posta elettronica da cui verrà inviata la notifica.

properties.platformVersion

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

properties.portalUrl
  • string

Publisher URL dell'endpoint del portale del servizio di Gestione API.

properties.privateEndpointConnections

Elenco delle connessioni endpoint privato di questo servizio.

properties.privateIPAddresses
  • string[]

Indirizzi IP con carico bilanciato statico privato del servizio Gestione API nell'area primaria distribuita in un Rete virtuale interno. Disponibile solo per lo SKU Basic, Standard, Premium e Isolato.

properties.provisioningState
  • string

Stato di provisioning corrente del servizio di Gestione API che può essere uno dei seguenti: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.

properties.publicIPAddresses
  • string[]

Indirizzi IP con carico bilanciato statico pubblico del servizio Gestione API nell'area primaria. Disponibile solo per lo SKU Basic, Standard, Premium e Isolato.

properties.publicIpAddressId
  • string

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

properties.publicNetworkAccess

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

properties.publisherEmail
  • string

Publisher messaggio di posta elettronica.

properties.publisherName
  • string

Nome del server di pubblicazione.

properties.restore
  • boolean
False

Annullare l'eliminazione del servizio Gestione API se è stato eliminato soft in precedenza. 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

Configurazione della rete virtuale del servizio Gestione API.

properties.virtualNetworkType None

Tipo di VPN in cui Gestione API servizio deve essere configurato. Nessuno (valore predefinito) indica che il servizio Gestione API non fa parte di alcuna Rete virtuale, external indica che la distribuzione Gestione API è configurata all'interno di un Rete virtuale con un endpoint con connessione Internet e internal significa che Gestione API distribuzione è configurata all'interno di un Rete virtuale avere solo un endpoint con connessione Intranet.

sku

Proprietà SKU del servizio Gestione API.

systemData

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

tags
  • object

Tag delle risorse.

type
  • string

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

zones
  • string[]

Elenco di zone di disponibilità che indicano da cui deve provenire la risorsa.

ApiManagementServiceSkuProperties

Gestione API proprietà sku della risorsa del servizio.

Name Type Description
capacity
  • integer

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

name

Nome dello SKU.

ApimIdentityType

Tipo di identità usata 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.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

ApiVersionConstraint

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

Name Type Description
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

Name Type Description
id
  • string

CertificateConfiguration

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

Name Type Description
certificate

Informazioni sul certificato.

certificatePassword
  • string

Password del certificato.

encodedCertificate
  • string

Certificato con codifica Base64.

storeName enum:
  • CertificateAuthority
  • Root

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

CertificateInformation

Informazioni sul certificato SSL.

Name Type Description
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 certificato.

Name Type Description
BuiltIn
  • string
Custom
  • string
KeyVault
  • string
Managed
  • string

CertificateStatus

Stato certificato.

Name Type Description
Completed
  • string
Failed
  • string
InProgress
  • string

createdByType

Tipo di identità che ha creato la risorsa.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorFieldContract

Contratto campo di errore.

Name Type Description
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.

Name Type Description
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

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.

Name Type Default Value Description
certificate

Informazioni sul certificato.

certificatePassword
  • string

Password del certificato.

certificateSource

Origine certificato.

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 il certificato SSL predefinito. L'impostazione viene applicata solo al tipo nome host proxy.

encodedCertificate
  • string

Certificato con codifica Base64.

hostName
  • string

Nome host da configurare nel servizio Gestione API.

identityClientId
  • string

ClientId identità gestita assegnata dal sistema o dall'utente generato da Azure AD, che ha accesso GET all'insieme di credenziali delle chiavi 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 che il servizio Gestione API sia configurato 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. Il valore predefinito è false.

type

Tipo nome host.

HostnameType

Tipo nome host.

Name Type Description
DeveloperPortal
  • string
Management
  • string
Portal
  • string
Proxy
  • string
Scm
  • string

PlatformVersion

Versione della piattaforma di calcolo che esegue il servizio.

Name Type Description
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

Non è possibile determinare la versione della piattaforma, perché la piattaforma di calcolo non viene distribuita.

PrivateEndpointServiceConnectionStatus

Stato della connessione dell'endpoint privato.

Name Type Description
Approved
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

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

Name Type Description
actionsRequired
  • string

Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer.

description
  • string

Motivo dell'approvazione/rifiuto della connessione.

status

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

PublicNetworkAccess

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

Name Type Description
Disabled
  • string
Enabled
  • string

RemotePrivateEndpointConnectionWrapper

Risorsa Connessione endpoint privato remoto.

Name Type Description
id
  • string

ID risorsa connessione endpoint privato

name
  • string

Nome connessione endpoint privato

properties.groupIds
  • string[]

Tutti gli ID gruppo.

properties.privateEndpoint

Risorsa dell'endpoint privato.

properties.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.

Name Type Description
Basic
  • string

SKU di base di Gestione API.

Consumption
  • string

SKU a consumo di Gestione API.

Developer
  • string

SKU per sviluppatori di Gestione API.

Isolated
  • string

SKU isolato di Gestione API.

Premium
  • string

Premium SKU di Gestione API.

Standard
  • string

SKU standard di Gestione API.

systemData

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

Name Type Description
createdAt
  • string

Timestamp della creazione di risorse (UTC).

createdBy
  • string

Identità che ha creato la risorsa.

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 volta la risorsa.

lastModifiedByType

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

UserIdentityProperties

Name Type Description
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.

Name Type Description
subnetResourceId
  • string

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

subnetname
  • string

Nome della subnet.

vnetid
  • string

ID della rete virtuale. Si tratta in genere di un GUID. Per impostazione predefinita, è previsto un GUID Null.

VirtualNetworkType

Tipo di VPN in cui Gestione API servizio deve essere configurato. Nessuno (valore predefinito) indica che il servizio Gestione API non fa parte di alcuna Rete virtuale, external indica che la distribuzione Gestione API è configurata all'interno di un Rete virtuale con un endpoint con connessione Internet e internal significa che Gestione API distribuzione è configurata all'interno di un Rete virtuale avere solo un endpoint con connessione Intranet.

Name Type Description
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 alcuna Rete virtuale.