Triggers - Get

Serviço:: Data Factory

Versão da API:: 2018-06-01

Obtém um gatilho.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	O nome da fábrica.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	O nome do grupo de recursos.
subscriptionId	path	True	string	O identificador de assinatura.
triggerName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>#.%&:\\+?/]$	O nome do gatilho.
api-version	query	True	string	A versão da API.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-None-Match		string	ETag da entidade de gatilho. Só deve ser especificado para get. Se a ETag corresponder à tag de entidade existente, ou se * foi fornecido, nenhum conteúdo será retornado.

Respostas

Name	Tipo	Description
200 OK	TriggerResource	OK.
Other Status Codes		Não modificado.
Other Status Codes	CloudError	Uma resposta de erro recebida do serviço Azure Data Factory.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Triggers_Get

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

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_Get.json
// this example is just showing the usage of "Triggers_Get" 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
DataFactoryTriggerResource result = await dataFactoryTrigger.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataFactoryTriggerData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Resposta da amostra

Código de estado:: 304

Código de estado:: 200

Date: Mon, 22 Apr 2019 18:33:52 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 11989
x-ms-request-id: 8ad1759f-24c1-46a5-aef5-edd267e18870
x-ms-correlation-request-id: 8ad1759f-24c1-46a5-aef5-edd267e18870

{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger",
  "name": "exampleTrigger",
  "type": "Microsoft.DataFactory/factories/triggers",
  "properties": {
    "type": "ScheduleTrigger",
    "typeProperties": {
      "recurrence": {
        "frequency": "Minute",
        "interval": 4,
        "startTime": "2019-04-22T18:32:52.527912Z",
        "endTime": "2019-04-22T18:48:52.5281747Z",
        "timeZone": "UTC"
      }
    },
    "pipelines": [
      {
        "pipelineReference": {
          "referenceName": "examplePipeline",
          "type": "PipelineReference"
        },
        "parameters": {
          "OutputBlobNameList": [
            "exampleoutput.csv"
          ]
        }
      }
    ],
    "runtimeState": "Stopped"
  },
  "etag": "1500544f-0000-0200-0000-5cbe09100000"
}

Definições

Name	Description
CloudError	O objeto que define a estrutura de uma resposta de erro do Azure Data Factory.
MultiplePipelineTrigger	Classe base para todos os gatilhos que suportam um a muitos modelo para gatilho para pipeline.
PipelineReference	Tipo de referência de pipeline.
TriggerPipelineReference	Pipeline que precisa ser acionado com os parâmetros fornecidos.
TriggerResource	Tipo de recurso de gatilho.
TriggerRuntimeState	Enumera o possível estado de Triggers.

CloudError

Object

O objeto que define a estrutura de uma resposta de erro do Azure Data Factory.

Name	Tipo	Description
error.code	string	Código de erro.
error.details	CloudError[]	Matriz com detalhes de erro adicionais.
error.message	string	Mensagem de erro.
error.target	string	Nome/caminho da propriedade na solicitação associada ao erro.

MultiplePipelineTrigger

Object

Classe base para todos os gatilhos que suportam um a muitos modelo para gatilho para pipeline.

Name	Tipo	Description
annotations	object[]	Lista de tags que podem ser usadas para descrever o gatilho.
description	string	Descrição do gatilho.
pipelines	TriggerPipelineReference[]	Pipelines que precisam ser iniciados.
runtimeState	TriggerRuntimeState	Indica se o gatilho está em execução ou não. Atualizado quando as APIs Start/Stop são chamadas no Trigger.
type	string: MultiplePipelineTrigger	Tipo de gatilho.

PipelineReference

Object

Tipo de referência de pipeline.

Name	Tipo	Description
name	string	Nome de referência.
referenceName	string	Nome do pipeline de referência.
type	enum: PipelineReference	Tipo de referência de pipeline.

TriggerPipelineReference

Object

Pipeline que precisa ser acionado com os parâmetros fornecidos.

Name	Tipo	Description
parameters	object	Parâmetros do pipeline.
pipelineReference	PipelineReference	Referência de pipeline.

TriggerResource

Object

Tipo de recurso de gatilho.

Name	Tipo	Description
etag	string	Etag identifica a alteração no recurso.
id	string	O identificador de recurso.
name	string	O nome do recurso.
properties	Trigger: MultiplePipelineTrigger	Propriedades do gatilho.
type	string	O tipo de recurso.

TriggerRuntimeState

Enumeração

Enumera o possível estado de Triggers.

Valor	Description
Started
Stopped
Disabled

Partilhar via

Triggers - Get

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Triggers_Get

Pedido de amostra

Resposta da amostra

Definições

CloudError

MultiplePipelineTrigger

PipelineReference

TriggerPipelineReference

TriggerResource

TriggerRuntimeState