Api Management Service - Backup

Crea una copia de seguridad del servicio API Management en la cuenta de Azure Storage especificada. Esta operación es de larga duración y puede tardar varios minutos en completarse.

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

Parámetros de identificador URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nombre del grupo de recursos.

serviceName
path True
  • string

Nombre del servicio API Management.

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

subscriptionId
path True
  • string

Credenciales de suscripción que identifican de forma única Microsoft Azure suscripción. El identificador de suscripción forma parte del URI para cada llamada al servicio.

api-version
query True
  • string

Versión de la API que se va a usar con la solicitud de cliente.

Cuerpo de la solicitud

Name Required Type Description
backupName True
  • string

Nombre del archivo de copia de seguridad que se va a crear o recuperar.

containerName True
  • string

Nombre del contenedor de blobs (que se usa para colocar o recuperar la copia de seguridad).

storageAccount True
  • string

Nombre de la cuenta de almacenamiento de Azure (que se usa para colocar o recuperar la copia de seguridad).

accessKey
  • string

Clave de acceso de la cuenta de almacenamiento. Solo es necesario si accessType se establece en AccessKey.

accessType

Tipo de acceso que se va a usar para la cuenta de almacenamiento.

clientId
  • string

Identificador de cliente de la identidad administrada asignada por el usuario. Solo es necesario si accessType se establece en UserAssignedManagedIdentity.

Respuestas

Name Type Description
200 OK

Se ha realizado correctamente una copia de seguridad del servicio API Management en la cuenta de almacenamiento.

202 Accepted

Aceptado: el encabezado location contiene la dirección URL donde se puede comprobar el estado de la operación de larga duración.

Other Status Codes

Respuesta de error que describe el motivo del error de la operación.

Seguridad

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 suplantar la cuenta de usuario

Ejemplos

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"
  }
}

Definiciones

AccessType

Tipo de acceso que se va a usar para la cuenta de almacenamiento.

AdditionalLocation

Descripción de una ubicación de recursos API Management adicional.

ApiManagementServiceBackupRestoreParameters

Parámetros proporcionados a la copia de seguridad o restauración de una operación de servicio de API Management.

ApiManagementServiceIdentity

Propiedades de identidad del recurso del servicio Api Management.

ApiManagementServiceResource

Un único recurso de servicio API Management en list or Get response (Enumerar u obtener respuesta).

ApiManagementServiceSkuProperties

API Management propiedades de SKU de recursos de servicio.

ApimIdentityType

Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio.

ApiVersionConstraint

Restricción de versión de api de plano de control para el servicio API Management.

ArmIdWrapper

Contenedor para un identificador de recurso de ARM

CertificateConfiguration

Configuración de certificado que consta de certificados intermedios y certificados raíz que no son de confianza.

CertificateInformation

Información del certificado SSL.

CertificateSource

Origen del certificado.

CertificateStatus

Estado del certificado.

createdByType

Tipo de identidad que creó el recurso.

ErrorFieldContract

Contrato de campo de error.

ErrorResponse

Respuesta de error.

HostnameConfiguration

Configuración de nombre de host personalizada.

HostnameType

Tipo de nombre de host.

PlatformVersion

Versión de la plataforma de proceso que ejecuta el servicio.

PrivateEndpointServiceConnectionStatus

Estado de conexión del punto de conexión privado.

PrivateLinkServiceConnectionState

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.

PublicNetworkAccess

Si se permite o no el acceso al punto de conexión público para este servicio API Management. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado". Si "Disabled", los puntos de conexión privados son el método de acceso exclusivo. El valor predeterminado es "Enabled"

RemotePrivateEndpointConnectionWrapper

Recurso de conexión de punto de conexión privado remoto.

SkuType

Nombre de la SKU.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

UserIdentityProperties
VirtualNetworkConfiguration

Configuración de una red virtual en la que se implementa API Management servicio.

VirtualNetworkType

Tipo de VPN en el que se debe configurar API Management servicio. Ninguno (valor predeterminado) significa que el servicio API Management no forma parte de ninguna Virtual Network, external significa que la implementación de API Management se configura dentro de un Virtual Network que tiene un punto de conexión accesible desde Internet y significa internamente que API Management la implementación se configura dentro de un Virtual Network tener solo un punto de conexión accesible desde la intranet.

AccessType

Tipo de acceso que se va a usar para la cuenta de almacenamiento.

Name Type Description
AccessKey
  • string

Use la clave de acceso.

SystemAssignedManagedIdentity
  • string

Use la identidad administrada asignada por el sistema.

UserAssignedManagedIdentity
  • string

Use la identidad administrada asignada por el usuario.

AdditionalLocation

Descripción de una ubicación de recursos API Management adicional.

Name Type Default Value Description
disableGateway
  • boolean
False

La propiedad solo es válida para un servicio api Management implementado en varias ubicaciones. Esto se puede usar para deshabilitar la puerta de enlace en esta ubicación adicional.

gatewayRegionalUrl
  • string

Dirección URL de puerta de enlace del servicio API Management en la región.

location
  • string

Nombre de ubicación de la región adicional entre las regiones del centro de datos de Azure.

platformVersion

Versión de la plataforma de proceso que ejecuta el servicio.

privateIPAddresses
  • string[]

Direcciones IP de carga equilibrada estática privada del servicio API Management que se implementa en un Virtual Network interno en una ubicación adicional determinada. Solo está disponible para la SKU básica, estándar, Premium y aislada.

publicIPAddresses
  • string[]

Direcciones IP públicas de carga equilibrada estática del servicio API Management en la ubicación adicional. Solo está disponible para la SKU básica, estándar, Premium y aislada.

publicIpAddressId
  • string

Dirección IP V4 basada en la SKU estándar pública que se va a asociar con Virtual Network servicio implementado en la ubicación. Solo se admite para Premium SKU que se implementa en Virtual Network.

sku

Propiedades de SKU del servicio API Management.

virtualNetworkConfiguration

Configuración de red virtual para la ubicación.

zones
  • string[]

Una lista de zonas de disponibilidad que indica dónde debe proceder el recurso.

ApiManagementServiceBackupRestoreParameters

Parámetros proporcionados a la copia de seguridad o restauración de una operación de servicio de API Management.

Name Type Default Value Description
accessKey
  • string

Clave de acceso de la cuenta de almacenamiento. Solo es necesario si accessType se establece en AccessKey.

accessType AccessKey

Tipo de acceso que se va a usar para la cuenta de almacenamiento.

backupName
  • string

Nombre del archivo de copia de seguridad que se va a crear o recuperar.

clientId
  • string

Identificador de cliente de la identidad administrada asignada por el usuario. Solo es necesario si accessType se establece en UserAssignedManagedIdentity.

containerName
  • string

Nombre del contenedor de blobs (que se usa para colocar o recuperar la copia de seguridad).

storageAccount
  • string

Nombre de la cuenta de almacenamiento de Azure (que se usa para colocar o recuperar la copia de seguridad).

ApiManagementServiceIdentity

Propiedades de identidad del recurso del servicio Api Management.

Name Type Description
principalId
  • string

Identificador de entidad de seguridad de la identidad.

tenantId
  • string

Identificador de inquilino de cliente de la identidad.

type

Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio.

userAssignedIdentities

Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidades de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Un único recurso de servicio API Management en list or Get response (Enumerar u obtener respuesta).

Name Type Default Value Description
etag
  • string

ETag del recurso.

id
  • string

Identificador del recurso.

identity

Identidad de servicio administrada del servicio Api Management.

location
  • string

Ubicación del recurso

name
  • string

Nombre del recurso.

properties.additionalLocations

Ubicaciones adicionales del centro de datos del servicio API Management.

properties.apiVersionConstraint

Restricción de versión de api de plano de control para el servicio API Management.

properties.certificates

Lista de certificados que deben instalarse en el servicio API Management. El número máximo de certificados admitidos que se pueden instalar es 10.

properties.createdAtUtc
  • string

Fecha UTC de creación del servicio API Management. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.

properties.customProperties
  • object

Propiedades personalizadas del servicio API Management.
La configuración Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 deshabilitará la TLS_RSA_WITH_3DES_EDE_CBC_SHA de cifrado para todas las TLS(1.0, 1.1 y 1.2).
La configuración Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 se puede usar para deshabilitar solo TLS 1.1.
La configuración Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 se puede usar para deshabilitar TLS 1.0 en un servicio de API Management.
La configuración Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 se puede usar para deshabilitar solo TLS 1.1 para las comunicaciones con back-end.
La configuración Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 se puede usar para deshabilitar TLS 1.0 para las comunicaciones con back-end.
La configuración Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 se puede usar para habilitar el protocolo HTTP2 en un servicio API Management.
Si no se especifica ninguna de estas propiedades en la operación PATCH, se restablecerán los valores de las propiedades omitidas en sus valores predeterminados. Para todas las configuraciones excepto Http2, el valor predeterminado es True si el servicio se creó el 1 de abril de 2018 o antes de False lo contrario. El valor predeterminado de la configuración http2 es False.

Puede deshabilitar cualquiera de los siguientes cifrados mediante la configuración 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. Por ejemplo, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. El valor predeterminado es true para ellos. Nota: Los siguientes cifrados no se pueden deshabilitar porque son necesarios para los componentes internos de 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

Dirección URL del punto de conexión del portal de DEveloper del servicio API Management.

properties.disableGateway
  • boolean
False

La propiedad solo es válida para un servicio api Management implementado en varias ubicaciones. Se puede usar para deshabilitar la puerta de enlace en la región maestra.

properties.enableClientCertificate
  • boolean
False

La propiedad solo está pensada para usarse para el servicio de SKU de consumo. Esto exige que se presente un certificado de cliente en cada solicitud a la puerta de enlace. Esto también permite autenticar el certificado en la directiva de la puerta de enlace.

properties.gatewayRegionalUrl
  • string

Dirección URL de puerta de enlace del servicio API Management en la región predeterminada.

properties.gatewayUrl
  • string

Dirección URL de puerta de enlace del servicio API Management.

properties.hostnameConfigurations

Configuración de nombre de host personalizada del servicio API Management.

properties.managementApiUrl
  • string

Dirección URL del punto de conexión de la API de administración del servicio API Management.

properties.notificationSenderEmail
  • string

Dirección de correo electrónico desde la que se enviará la notificación.

properties.platformVersion

Versión de la plataforma de proceso que ejecuta el servicio en esta ubicación.

properties.portalUrl
  • string

Publisher dirección URL del punto de conexión del portal del servicio API Management.

properties.privateEndpointConnections

Lista de conexiones de punto de conexión privado de este servicio.

properties.privateIPAddresses
  • string[]

Direcciones IP de carga equilibrada estática privada del servicio API Management en la región primaria que se implementa en un Virtual Network interno. Solo está disponible para la SKU básica, estándar, Premium y aislada.

properties.provisioningState
  • string

El estado de aprovisionamiento actual del servicio API Management que puede ser uno de los siguientes: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.

properties.publicIPAddresses
  • string[]

Direcciones IP estáticas públicas con equilibrio de carga del servicio API Management en la región primaria. Solo está disponible para la SKU básica, estándar, Premium y aislada.

properties.publicIpAddressId
  • string

Dirección IP V4 basada en la SKU estándar pública que se asociará con Virtual Network servicio implementado en la región. Solo se admite para la SKU de desarrollador y Premium que se implementa en Virtual Network.

properties.publicNetworkAccess

Si se permite o no el acceso al punto de conexión público para este servicio API Management. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado". Si es "Deshabilitado", los puntos de conexión privados son el método de acceso exclusivo. El valor predeterminado es "Enabled"

properties.publisherEmail
  • string

Publisher correo electrónico.

properties.publisherName
  • string

Publisher nombre.

properties.restore
  • boolean
False

Recuperar el servicio Api Management si se eliminó temporalmente. Si se especifica esta marca y se establece en True, se omitirán todas las demás propiedades.

properties.scmUrl
  • string

Dirección URL del punto de conexión de SCM del servicio API Management.

properties.targetProvisioningState
  • string

El estado de aprovisionamiento del servicio API Management, que está destinado a la operación de larga duración iniciada en el servicio.

properties.virtualNetworkConfiguration

Configuración de red virtual del servicio API Management.

properties.virtualNetworkType None

Tipo de VPN en el que se debe configurar API Management servicio. None (Valor predeterminado) significa que el servicio API Management no forma parte de ninguna Virtual Network, External significa que la implementación de API Management está configurada dentro de un Virtual Network que tiene un punto de conexión accesible desde Internet y Internal significa que API Management la implementación se configura dentro de un Virtual Network tener solo un punto de conexión accesible desde la intranet.

sku

Propiedades de SKU del servicio API Management.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

tags
  • object

Etiquetas del recurso.

type
  • string

El tipo de recurso para API Management recurso se establece en Microsoft.ApiManagement.

zones
  • string[]

Lista de zonas de disponibilidad de las que se indica dónde debe proceder el recurso.

ApiManagementServiceSkuProperties

API Management propiedades de SKU de recursos de servicio.

Name Type Description
capacity
  • integer

Capacidad de la SKU (número de unidades implementadas de la SKU). Para la capacidad de SKU de consumo debe especificarse como 0.

name

Nombre de la SKU.

ApimIdentityType

Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio.

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

ApiVersionConstraint

Restricción de versión de api de plano de control para el servicio API Management.

Name Type Description
minApiVersion
  • string

Limite las llamadas API del plano de control a API Management servicio con la versión igual o posterior a este valor.

ArmIdWrapper

Contenedor para un identificador de recurso de ARM

Name Type Description
id
  • string

CertificateConfiguration

Configuración de certificado que consta de certificados intermedios y certificados raíz que no son de confianza.

Name Type Description
certificate

Información del certificado.

certificatePassword
  • string

Contraseña del certificado.

encodedCertificate
  • string

Certificado codificado en Base64.

storeName enum:
  • CertificateAuthority
  • Root

Ubicación del almacén de certificados System.Security.Cryptography.x509certificates.StoreName. Solo root y CertificateAuthority son ubicaciones válidas.

CertificateInformation

Información del certificado SSL.

Name Type Description
expiry
  • string

Fecha de expiración del certificado. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.

subject
  • string

Asunto del certificado.

thumbprint
  • string

Huella digital del certificado

CertificateSource

Origen del certificado.

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

CertificateStatus

Estado del certificado.

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

createdByType

Tipo de identidad que creó el recurso.

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

ErrorFieldContract

Contrato de campo de error.

Name Type Description
code
  • string

Código de error de nivel de propiedad.

message
  • string

Representación legible del error de nivel de propiedad.

target
  • string

Nombre de propiedad.

ErrorResponse

Respuesta de error.

Name Type Description
error.code
  • string

Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.

error.details

La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.

error.message
  • string

Representación legible del error.

HostnameConfiguration

Configuración de nombre de host personalizada.

Name Type Default Value Description
certificate

Información del certificado.

certificatePassword
  • string

Contraseña del certificado.

certificateSource

Origen del certificado.

certificateStatus

Estado del certificado.

defaultSslBinding
  • boolean
False

Especifique true para configurar el certificado asociado a este nombre de host como certificado SSL predeterminado. Si un cliente no envía el encabezado SNI, será el certificado que se impugnará. La propiedad es útil si un servicio tiene habilitado varios nombres de host personalizados y debe decidir el certificado ssl predeterminado. La configuración solo se aplica al tipo de nombre de host de proxy.

encodedCertificate
  • string

Certificado codificado en Base64.

hostName
  • string

Nombre de host que se va a configurar en el servicio Api Management.

identityClientId
  • string

ClientId de identidad administrada asignada por el sistema o el usuario generado por Azure AD, que tiene acceso GET al almacén de claves que contiene el certificado SSL.

keyVaultId
  • string

Dirección URL al secreto de KeyVault que contiene el certificado Ssl. Si se proporciona la dirección URL absoluta que contiene la versión, la actualización automática del certificado ssl no funcionará. Esto requiere que el servicio Api Management se configure con aka.ms/apimmsi. El secreto debe ser de tipo application/x-pkcs12.

negotiateClientCertificate
  • boolean
False

Especifique true para negociar siempre el certificado de cliente en el nombre de host. El valor predeterminado es false.

type

Tipo de nombre de host.

HostnameType

Tipo de nombre de host.

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

PlatformVersion

Versión de la plataforma de proceso que ejecuta el servicio.

Name Type Description
mtv1
  • string

Plataforma que ejecuta el servicio en la plataforma Multi Tenant V1.

stv1
  • string

Plataforma que ejecuta el servicio en la plataforma single tenant V1.

stv2
  • string

Plataforma que ejecuta el servicio en la plataforma single tenant V2.

undetermined
  • string

No se puede determinar la versión de la plataforma, ya que la plataforma de proceso no está implementada.

PrivateEndpointServiceConnectionStatus

Estado de conexión del punto de conexión privado.

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

PrivateLinkServiceConnectionState

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.

Name Type Description
actionsRequired
  • string

Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.

description
  • string

Motivo de aprobación o rechazo de la conexión.

status

Indica si el propietario del servicio ha aprobado, rechazado o quitado la conexión.

PublicNetworkAccess

Si se permite o no el acceso al punto de conexión público para este servicio API Management. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado". Si "Disabled", los puntos de conexión privados son el método de acceso exclusivo. El valor predeterminado es "Enabled"

Name Type Description
Disabled
  • string
Enabled
  • string

RemotePrivateEndpointConnectionWrapper

Recurso de conexión de punto de conexión privado remoto.

Name Type Description
id
  • string

Identificador de recurso de conexión de punto de conexión privado

name
  • string

Nombre de conexión de punto de conexión privado

properties.groupIds
  • string[]

Todos los identificadores de grupo.

properties.privateEndpoint

Recurso del punto de conexión privado.

properties.privateLinkServiceConnectionState

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.

properties.provisioningState
  • string

Estado de aprovisionamiento del recurso de conexión de punto de conexión privado.

type
  • string

Tipo de recurso de conexión de punto de conexión privado

SkuType

Nombre de la SKU.

Name Type Description
Basic
  • string

SKU básica de Api Management.

Consumption
  • string

SKU de consumo de Api Management.

Developer
  • string

SKU para desarrolladores de Api Management.

Isolated
  • string

SKU aislada de Api Management.

Premium
  • string

Premium SKU de Api Management.

Standard
  • string

SKU estándar de Api Management.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Name Type Description
createdAt
  • string

Marca de tiempo de creación de recursos (UTC).

createdBy
  • string

Identidad que creó el recurso.

createdByType

Tipo de identidad que creó el recurso.

lastModifiedAt
  • string

Marca de tiempo de la última modificación del recurso (UTC)

lastModifiedBy
  • string

Identidad que modificó por última vez el recurso.

lastModifiedByType

Tipo de identidad que modificó por última vez el recurso.

UserIdentityProperties

Name Type Description
clientId
  • string

Identificador de cliente de la identidad asignada por el usuario.

principalId
  • string

Identificador principal de la identidad asignada por el usuario.

VirtualNetworkConfiguration

Configuración de una red virtual en la que se implementa API Management servicio.

Name Type Description
subnetResourceId
  • string

Identificador de recurso completo de una subred en una red virtual en la que se va a implementar el servicio API Management.

subnetname
  • string

Nombre de la subred.

vnetid
  • string

Identificador de red virtual. Normalmente, se trata de un GUID. Espere un GUID nulo de forma predeterminada.

VirtualNetworkType

Tipo de VPN en el que se debe configurar API Management servicio. Ninguno (valor predeterminado) significa que el servicio API Management no forma parte de ninguna Virtual Network, external significa que la implementación de API Management se configura dentro de un Virtual Network que tiene un punto de conexión accesible desde Internet y significa internamente que API Management la implementación se configura dentro de un Virtual Network tener solo un punto de conexión accesible desde la intranet.

Name Type Description
External
  • string

El servicio forma parte de Virtual Network y es accesible desde Internet.

Internal
  • string

El servicio forma parte de Virtual Network y solo es accesible desde dentro de la red virtual.

None
  • string

El servicio no forma parte de ninguna Virtual Network.