Referencia de proxy de recurso personalizado

Artículo
06/01/2023

En este artículo se analizarán los requerimientos de los puntos de conexión que implementan los recursos personalizados de proxy. Si no está familiarizado con los proveedores de recursos personalizados de Azure, consulte la introducción a los proveedores de recursos personalizados.

Definición de un punto de conexión de recursos de proxy

Puede crear un recurso de proxy si especifica routingType en "Proxy".

Proveedor de recursos personalizados de ejemplo:

{
  "properties": {
    "resourceTypes": [
      {
        "name": "myCustomResources",
        "routingType": "Proxy",
        "endpoint": "https://{endpointURL}/"
      }
    ]
  },
  "location": "eastus",
  "type": "Microsoft.CustomProviders/resourceProviders",
  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}",
  "name": "{resourceProviderName}"
}

Creación de un punto de conexión de recursos de proxy

Un punto de conexión que implementa un punto de conexión de recurso "Proxy" debe controlar la solicitud la respuesta de la API nueva en Azure. En este caso, #resourceType* generará una nueva API de recursos de Azure para que PUT, GET y DELETE ejecuten CRUD en un recurso único, así como para que GET recupere todos los recursos existentes.

Nota

Los campos id, name y type no son obligatorios, pero sí son necesarios para integrar el recurso personalizado con un ecosistema existente de Azure.

Recurso de ejemplo:

{
    "name": "{myCustomResourceName}",
    "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}",
    "type": "Microsoft.CustomProviders/resourceProviders/myCustomResources",
    "properties": {
        "myProperty1": "myPropertyValue1",
        "myProperty2": {
            "myProperty3" : "myPropertyValue3"
        }
    }
}

Referencia de los parámetros:

Propiedad	Muestra	Descripción
name	"{myCustomResourceName}"	El nombre del recurso personalizado.
type	"Microsoft.CustomProviders/resourceProviders/{resourceTypeName}"	El espacio de nombres del tipo de recurso.
id	"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomResources/{myCustomResourceName}"	El identificador del recurso.

Creación de un recurso personalizado

Solicitud entrante de Azure API:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resource-provider-name}/myCustomResources/{myCustomResourceName}?api-version=2018-09-01-preview
Authorization: Bearer eyJ0e...
Content-Type: application/json

{
    "properties": {
        "myProperty1": "myPropertyValue1",
        "myProperty2": {
            "myProperty3" : "myPropertyValue3"
        }
    }
}

Esta solicitud se reenviará al punto de conexión de esta forma:

PUT https://{endpointURL}/?api-version=2018-09-01-preview
Content-Type: application/json
X-MS-CustomProviders-RequestPath: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}

{
    "properties": {
        "myProperty1": "myPropertyValue1",
        "myProperty2": {
            "myProperty3" : "myPropertyValue3"
        }
    }
}

La respuesta del punto de conexión se reenvía de vuelta al cliente. La respuesta debe devolver:

Un documento de objeto JSON válido. Todas las matrices y cadenas deben estar anidadas bajo un objeto superior.
El encabezado Content-Type se debe establecer en "application/json; charset=utf-8".

Respuesta del punto de conexión:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "name": "{myCustomResourceName}",
    "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}",
    "type": "Microsoft.CustomProviders/resourceProviders/myCustomResources",
    "properties": {
        "myProperty1": "myPropertyValue1",
        "myProperty2": {
            "myProperty3" : "myPropertyValue3"
        }
    }
}

Respuesta del proveedor de recursos personalizado de Azure:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "name": "{myCustomResourceName}",
    "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}",
    "type": "Microsoft.CustomProviders/resourceProviders/myCustomResources",
    "properties": {
        "myProperty1": "myPropertyValue1",
        "myProperty2": {
            "myProperty3" : "myPropertyValue3"
        }
    }
}

Eliminación de un recurso personalizado

Solicitud entrante de Azure API:

Delete https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}?api-version=2018-09-01-preview
Authorization: Bearer eyJ0e...
Content-Type: application/json

Esta solicitud se reenviará al punto de conexión de esta forma:

Delete https://{endpointURL}/?api-version=2018-09-01-preview
Content-Type: application/json
X-MS-CustomProviders-RequestPath: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}

La respuesta del punto de conexión se reenvía de vuelta al cliente. La respuesta debe devolver:

Un documento de objeto JSON válido. Todas las matrices y cadenas deben estar anidadas bajo un objeto superior.
El encabezado Content-Type se debe establecer en "application/json; charset=utf-8".

Respuesta del punto de conexión:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

Respuesta del proveedor de recursos personalizado de Azure:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

Recuperación de un recurso personalizado

Solicitud entrante de Azure API:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}?api-version=2018-09-01-preview
Authorization: Bearer eyJ0e...
Content-Type: application/json

Esta solicitud se reenviará al punto de conexión de esta forma:

GET https://{endpointURL}/?api-version=2018-09-01-preview
Content-Type: application/json
X-MS-CustomProviders-RequestPath: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}

La respuesta del punto de conexión se reenvía de vuelta al cliente. La respuesta debe devolver:

Un documento de objeto JSON válido. Todas las matrices y cadenas deben estar anidadas bajo un objeto superior.
El encabezado Content-Type se debe establecer en "application/json; charset=utf-8".

Respuesta del punto de conexión:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "name": "{myCustomResourceName}",
    "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}",
    "type": "Microsoft.CustomProviders/resourceProviders/myCustomResources",
    "properties": {
        "myProperty1": "myPropertyValue1",
        "myProperty2": {
            "myProperty3" : "myPropertyValue3"
        }
    }
}

Respuesta del proveedor de recursos personalizado de Azure:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "name": "{myCustomResourceName}",
    "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}",
    "type": "Microsoft.CustomProviders/resourceProviders/myCustomResources",
    "properties": {
        "myProperty1": "myPropertyValue1",
        "myProperty2": {
            "myProperty3" : "myPropertyValue3"
        }
    }
}

Enumeración de todos los recursos personalizados

Solicitud entrante de Azure API:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources?api-version=2018-09-01-preview
Authorization: Bearer eyJ0e...
Content-Type: application/json

Esta solicitud se reenviará al punto de conexión de esta forma:

GET https://{endpointURL}/?api-version=2018-09-01-preview
Content-Type: application/json
X-MS-CustomProviders-RequestPath: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources

La respuesta del punto de conexión se reenvía de vuelta al cliente. La respuesta debe devolver:

Un documento de objeto JSON válido. Todas las matrices y cadenas deben estar anidadas bajo un objeto superior.
El encabezado Content-Type se debe establecer en "application/json; charset=utf-8".
La lista de recursos se debe colocar bajo la propiedad value de nivel superior.

Respuesta del punto de conexión:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "value" : [
        {
            "name": "{myCustomResourceName}",
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}",
            "type": "Microsoft.CustomProviders/resourceProviders/myCustomResources",
            "properties": {
                "myProperty1": "myPropertyValue1",
                "myProperty2": {
                    "myProperty3" : "myPropertyValue3"
                }
            }
        }
    ]
}

Respuesta del proveedor de recursos personalizado de Azure:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "value" : [
        {
            "name": "{myCustomResourceName}",
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}",
            "type": "Microsoft.CustomProviders/resourceProviders/myCustomResources",
            "properties": {
                "myProperty1": "myPropertyValue1",
                "myProperty2": {
                    "myProperty3" : "myPropertyValue3"
                }
            }
        }
    ]
}

Pasos siguientes

Introducción a los proveedores de recursos personalizados de Azure
Inicio rápido: Creación de un proveedor de recursos personalizados de Azure e implementación de recursos personalizados
Tutorial: Creación de acciones y recursos personalizados en Azure
Cómo: Adding Custom Actions to Azure REST API (Adición de acciones personalizadas a la API REST de Azure)
Referencia: Custom Resource Cache Reference (Referencia: Referencia de caché de recurso personalizado)

Compartir vía

Referencia de proxy de recurso personalizado

Definición de un punto de conexión de recursos de proxy

Proveedor de recursos personalizados de ejemplo:

Creación de un punto de conexión de recursos de proxy

Creación de un recurso personalizado

Eliminación de un recurso personalizado

Recuperación de un recurso personalizado

Enumeración de todos los recursos personalizados

Pasos siguientes

Comentarios

Recursos adicionales