Api Management Service - Create Or Update

Crea o aggiorna un servizio di Gestione API. Questa operazione è a esecuzione prolungata e potrebbe richiedere diversi minuti per completare.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}?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 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
location True
  • string

Percorso della risorsa.

properties.publisherEmail True
  • string

Publisher posta elettronica.

properties.publisherName True
  • string

Nome del server di pubblicazione.

sku True

Proprietà SKU del servizio Gestione API.

identity

Identità del servizio gestito del servizio Gestione API.

properties.additionalLocations

Località del data center aggiuntive del servizio Gestione API.

properties.apiVersionConstraint

Vincolo di versione api 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 possono essere installati è 10.

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 qualsiasi crittografia successiva 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 crittografia successive non possono essere disabilitate poiché sono necessarie 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.disableGateway
  • boolean

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

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. In questo modo è anche possibile autenticare il certificato nel criterio nel gateway.

properties.hostnameConfigurations

Configurazione personalizzata del nome host del servizio Gestione API.

properties.notificationSenderEmail
  • string

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

properties.privateEndpointConnections

Elenco delle connessioni endpoint private di questo servizio.

properties.publicIpAddressId
  • string

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

properties.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.restore
  • boolean

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

properties.virtualNetworkConfiguration

Configurazione della rete virtuale del servizio di Gestione API.

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

tags
  • object

Tag di risorse.

zones
  • string[]

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

Risposte

Name Type Description
200 OK

Il servizio è stato configurato correttamente.

201 Created

Data di creazione

202 Accepted

Accettata la modifica della configurazione durante l'aggiornamento del servizio.

Other Status Codes

Risposta di errore che descrive perché 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

ApiManagementCreateMultiRegionServiceWithCustomHostname
ApiManagementCreateService
ApiManagementCreateServiceHavingMsi
ApiManagementCreateServiceInVnetWithPublicIP
ApiManagementCreateServiceInZones
ApiManagementCreateServiceWithCustomHostnameKeyVault
ApiManagementCreateServiceWithSystemCertificates
ApiManagementCreateServiceWithUserAssignedIdentity
ApiManagementUndelete

ApiManagementCreateMultiRegionServiceWithCustomHostname

Sample Request

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

{
  "properties": {
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "encodedCertificate": "****** Base 64 Encoded Certificate ************",
        "certificatePassword": "Password",
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "encodedCertificate": "****** Base 64 Encoded Certificate ************",
        "certificatePassword": "Password"
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "encodedCertificate": "****** Base 64 Encoded Certificate ************",
        "certificatePassword": "Password"
      }
    ],
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "additionalLocations": [
      {
        "location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "disableGateway": true
      }
    ],
    "virtualNetworkType": "None",
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "location": "West US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?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": "AAAAAAACXoo=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2019-12-18T08:04:26.9492661Z",
    "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": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "additionalLocations": [
      {
        "location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "disableGateway": true
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}
{
  "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": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXF1D174FDB3A2",
          "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
  }
}
location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?api-version=2021-08-01

ApiManagementCreateService

Sample Request

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

{
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo"
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  },
  "location": "South Central US",
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  }
}

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": {
    "Name": "Contoso",
    "Test": "User"
  },
  "location": "South Central US",
  "etag": "AAAAAAAp3P0=",
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2019-12-18T06:10:56.0327105Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  },
  "location": "South Central US",
  "etag": "AAAAAAAp3T4=",
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:10:56.0327105Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-southcentralus-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": [
      "23.102.171.124"
    ],
    "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": {}
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/c2RrdGVzdGFwaW0xNTkxX0FjdF9jZTkyMmNmOQ==?api-version=2021-08-01

ApiManagementCreateServiceHavingMsi

Sample Request

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

{
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "West US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

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": "AAAAAAAAWiE=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2019-04-11T16:29:29.9711098Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "dfb9a757-df69-4966-a8d0-711a9cd8ffb4",
    "tenantId": "XXXXXX-86f1-41af-91ab-2d7cd011db47"
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
{
  "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": "AAAAAAAAWiU=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-04-11T16:29:29.9711098Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "virtualNetworkType": "None",
    "enableClientCertificate": false,
    "platformVersion": "mtv1"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "dfb9a757-df69-4966-a8d0-711a9cd8ffb4",
    "tenantId": "XXXXXX-86f1-41af-91ab-2d7cd011db47"
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01

ApiManagementCreateServiceInVnetWithPublicIP

Sample Request

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

{
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant"
    },
    "publicIpAddressId": "/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet",
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "Premium",
    "capacity": 2
  },
  "zones": [
    "1",
    "2"
  ],
  "location": "East US 2 EUAP",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

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": "East US 2 EUAP",
  "etag": "AAAAAAAiXto=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2020-07-28T23:18:14.6562474Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIpAddressId": "/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant"
    },
    "virtualNetworkType": "External",
    "disableGateway": false,
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 2
  },
  "zones": [
    "1",
    "2"
  ],
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "East US 2 EUAP",
  "etag": "AAAAAAAGTAs=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2021-02-22T06:53:46.6409875Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-eastus2euap-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
      }
    ],
    "publicIPAddresses": [
      "20.47.137.XXX"
    ],
    "publicIpAddressId": "/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant"
    },
    "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": "External",
    "disableGateway": false,
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 2
  },
  "zones": [
    "1",
    "2"
  ],
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01

ApiManagementCreateServiceInZones

Sample Request

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

{
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk"
  },
  "sku": {
    "name": "Premium",
    "capacity": 2
  },
  "zones": [
    "1",
    "2"
  ],
  "location": "North europe",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

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": "North Europe",
  "etag": "AAAAAAAiXto=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2020-07-28T23:18:14.6562474Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false,
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 2
  },
  "zones": [
    "1",
    "2"
  ],
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "North Europe",
  "etag": "AAAAAAAiXvE=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-07-28T23:18:14.6562474Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-northeurope-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
      }
    ],
    "publicIPAddresses": [
      "20.54.34.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,
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 2
  },
  "zones": [
    "1",
    "2"
  ],
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01

ApiManagementCreateServiceWithCustomHostnameKeyVault

Sample Request

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

{
  "properties": {
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468",
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468"
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468"
      }
    ],
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "virtualNetworkType": "None",
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  },
  "location": "North Europe",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?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": "North Europe",
  "etag": "AAAAAAAigi8=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2020-09-13T22:30:20.7759747Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468",
        "certificateSource": "KeyVault"
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468",
        "certificateSource": "KeyVault"
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468",
        "certificateSource": "KeyVault"
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false,
    "platformVersion": "stv2",
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "North Europe",
  "etag": "AAAAAAAigjU=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-09-13T22:30:20.7759747Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-northeurope-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": "gateway1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468",
        "certificateSource": "KeyVault"
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468",
        "certificateSource": "KeyVault"
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "keyVaultId": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2037-01-01T07:00:00+00:00",
          "thumbprint": "EA276907917CB5XXXXXXXXXXX690",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false,
        "identityClientId": "329419bc-adec-4dce-9568-25a6d486e468",
        "certificateSource": "KeyVault"
      }
    ],
    "publicIPAddresses": [
      "40.112.74.192"
    ],
    "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,
    "platformVersion": "stv2",
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "UserAssigned",
    "tenantId": "f686d426-8d16-xxxx-xxxx-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "principalId": "15e769b2-xxxx-xxxx-xxxx-3fd9a923ac3a",
        "clientId": "329419bc-adec-4dce-9568-25a6d486e468"
      }
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?api-version=2021-08-01

ApiManagementCreateServiceWithSystemCertificates

Sample Request

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

{
  "properties": {
    "certificates": [
      {
        "encodedCertificate": "*******Base64 encoded Certificate******************",
        "certificatePassword": "Password",
        "storeName": "CertificateAuthority"
      }
    ],
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk"
  },
  "sku": {
    "name": "Basic",
    "capacity": 1
  },
  "location": "Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?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": "Central US",
  "etag": "AAAAAAAp3TM=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2019-12-18T06:33:28.0906918Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "virtualNetworkType": "None",
    "certificates": [
      {
        "storeName": "CertificateAuthority",
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989652CABCF585ACBFCB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        }
      }
    ],
    "disableGateway": false,
    "platformVersion": "stv2",
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Basic",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "Central US",
  "etag": "AAAAAAAp3UM=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:33:28.0906918Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centralus-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": [
      "40.113.223.117"
    ],
    "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",
    "certificates": [
      {
        "storeName": "CertificateAuthority",
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989652CABCF585ACBFCB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        }
      }
    ],
    "disableGateway": false,
    "platformVersion": "stv2",
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Basic",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/bXVsdGlob3N0bmFtZW11bHRpcmVnaW9uc2VydmljZV9BY3RfZjFiOTZhMjc=?api-version=2021-08-01

ApiManagementCreateServiceWithUserAssignedIdentity

Sample Request

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

{
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {}
    }
  },
  "location": "West US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  }
}

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": "AAAAAAAFzyQ=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2020-03-12T01:05:33.4573398Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "virtualNetworkType": "None",
    "platformVersion": "mtv1"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {}
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
{
  "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": "AAAAAAAFzyk=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-03-12T01:05:33.4573398Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "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,
    "platformVersion": "mtv1"
  },
  "sku": {
    "name": "Consumption",
    "capacity": 0
  },
  "identity": {
    "type": "UserAssigned",
    "tenantId": "XXXXX-86f1-41af-XXXX-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {
        "principalId": "XXXXX-6e62-4649-9f54-a119fc1ba85e",
        "clientId": "5a2c6b8e-0905-XXXX-a772-993c9418137f"
      }
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01

ApiManagementUndelete

Sample Request

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

{
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo",
    "restore": true
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  },
  "location": "South Central US"
}

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",
  "location": "South Central US",
  "etag": "AAAAAAAp3P0=",
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2019-12-18T06:10:56.0327105Z",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true
      }
    ],
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "location": "South Central US",
  "etag": "AAAAAAAp3T4=",
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "foo",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:10:56.0327105Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-southcentralus-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
      }
    ],
    "publicIPAddresses": [
      "23.102.171.124"
    ],
    "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": {}
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  }
}
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/c2RrdGVzdGFwaW0xNTkxX0FjdF9jZTkyMmNmOQ==?api-version=2021-08-01

Definizioni

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.

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.

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

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 Premium SKU distribuito in Rete virtuale.

sku

Proprietà SKU del servizio Gestione API.

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.

Name Type Description
principalId
  • string

ID principale dell'identità.

tenantId
  • string

ID tenant client dell'identità.

type

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

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.

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 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 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 qualsiasi crittografia successiva 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 crittografia successive non possono essere disabilitate poiché sono necessarie 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. 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. In questo modo è anche possibile 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

Configurazione personalizzata del nome host del servizio Gestione API.

properties.managementApiUrl
  • string

URL dell'endpoint 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 Gestione API.

properties.privateEndpointConnections

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 sviluppatori e SKU di Premium distribuiti in Rete virtuale.

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

Publisher posta elettronica.

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

Configurazione della rete virtuale del servizio di Gestione API.

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

Proprietà SKU del servizio Gestione API.

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.

Name Type Description
capacity
  • integer

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

name

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.

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

ApiVersionConstraint

Vincolo di versione api 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 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.

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

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

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 nome host proxy.

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

Tipo hostname.

HostnameType

Tipo hostname.

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

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

PrivateEndpointServiceConnectionStatus

Stato di 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 nel provider di servizi richiedono eventuali 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

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'

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 del punto finale 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 di utilizzo 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 risorsa.

lastModifiedByType

Tipo di identità che ha modificato l'ultima 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 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.

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 alcun Rete virtuale.