Triggers - Unsubscribe From Events

Servicio:

Data Factory

Versión de la API:

2018-06-01

Cancele el desencadenador de eventos de cancelación de la suscripción de eventos.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/unsubscribeFromEvents?api-version=2018-06-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nombre de fábrica.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
triggerName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$	Nombre del desencadenador.
api-version	query	True	string minLength: 1	Versión de API que se usará para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	TriggerSubscriptionOperationStatus	Operación de Azure completada con éxito.
202 Accepted		Operación de recurso aceptada. Encabezados Location: string Retry-After: integer
Other Status Codes	CloudError	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Triggers_UnsubscribeFromEvents

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger/unsubscribeFromEvents?api-version=2018-06-01

Java

/**
 * Samples for Triggers UnsubscribeFromEvents.
 */
public final class Main {
    /*
     * x-ms-original-file: 2018-06-01/Triggers_UnsubscribeFromEvents.json
     */
    /**
     * Sample code: Triggers_UnsubscribeFromEvents.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void triggersUnsubscribeFromEvents(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.triggers().unsubscribeFromEvents("exampleResourceGroup", "exampleFactoryName", "exampleTrigger",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python triggers_unsubscribe_from_events.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataFactoryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-12345678abc",
    )

    response = client.triggers.begin_unsubscribe_from_events(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        trigger_name="exampleTrigger",
    ).result()
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/examples/Triggers_UnsubscribeFromEvents.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.DataFactory;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/examples/Triggers_UnsubscribeFromEvents.json
// this example is just showing the usage of "Triggers_UnsubscribeFromEvents" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataFactoryTriggerResource created on azure
// for more information of creating DataFactoryTriggerResource, please refer to the document of DataFactoryTriggerResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
string triggerName = "exampleTrigger";
ResourceIdentifier dataFactoryTriggerResourceId = DataFactoryTriggerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, triggerName);
DataFactoryTriggerResource dataFactoryTrigger = client.GetDataFactoryTriggerResource(dataFactoryTriggerResourceId);

// invoke the operation
ArmOperation<DataFactoryTriggerSubscriptionOperationResult> lro = await dataFactoryTrigger.UnsubscribeFromEventsAsync(WaitUntil.Completed);
DataFactoryTriggerSubscriptionOperationResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:

200

{
  "status": "Disabled",
  "triggerName": "exampleTrigger"
}

status code:

202

Location: https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger/getEventSubscriptionStatus?api-version=2018-06-01

Definiciones

Nombre	Description
CloudError	Objeto que define la estructura de una respuesta de error de Azure Data Factory.
EventSubscriptionStatus	Estado de la suscripción de eventos.
TriggerSubscriptionOperationStatus	Define la respuesta de una operación de suscripción de desencadenador.

CloudError

Objeto

Objeto que define la estructura de una respuesta de error de Azure Data Factory.

Nombre	Tipo	Description
error.code	string	Código de error.
error.details	CloudError[]	Matriz con detalles de error adicionales.
error.message	string	Mensaje de error.
error.target	string	Nombre o ruta de acceso de propiedad en la solicitud asociada al error.

EventSubscriptionStatus

Enumeración

Estado de la suscripción de eventos.

Valor	Description
Enabled	Habilitado
Provisioning	Aprovisionamiento
Deprovisioning	Desaprovisionamiento
Disabled	Deshabilitado
Unknown	Desconocido

TriggerSubscriptionOperationStatus

Objeto

Define la respuesta de una operación de suscripción de desencadenador.

Nombre	Tipo	Description
status	EventSubscriptionStatus	Estado de la suscripción de eventos.
triggerName	string	Nombre del desencadenador.