Web Apps - Get Workflow

Serviço:

App Service

Versão da API:

2024-04-01

Obtenha informações de fluxo de trabalho por sua ID para o site ou um slot de implantação.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows/{workflowName}?api-version=2024-04-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
name	path	True	string	Nome do site.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nome do grupo de recursos ao qual o recurso pertence.
subscriptionId	path	True	string	Sua ID de assinatura do Azure. Esta é uma cadeia de caracteres formatada por GUID (por exemplo, 000000000-0000-0000-0000-000000000000000).
workflowName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-z][a-z0-9]*$	Nome do fluxo de trabalho.
api-version	query	True	string	Versão da API

Respostas

Nome	Tipo	Description
200 OK	WorkflowEnvelope	Informações de fluxo de trabalho retornadas.
404 Not Found		O fluxo de trabalho com um nome de {workflowName} não existe.
Other Status Codes	DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

GET a workflow

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows/stateful1?api-version=2024-04-01

Java

/**
 * Samples for WebApps GetWorkflow.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWorkflow.json
     */
    /**
     * Sample code: GET a workflow.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void gETAWorkflow(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getWorkflowWithResponse("testrg123", "testsite2",
            "stateful1", 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.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python get_workflow.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 = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.web_apps.get_workflow(
        resource_group_name="testrg123",
        name="testsite2",
        workflow_name="stateful1",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWorkflow.json
if __name__ == "__main__":
    main()
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

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWorkflow.json
func ExampleWebAppsClient_GetInstanceWorkflowSlot() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebAppsClient().GetInstanceWorkflowSlot(ctx, "testrg123", "testsite2", "staging", "stateful1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WorkflowEnvelope = armappservice.WorkflowEnvelope{
	// 	Name: to.Ptr("testsite2/stateful1"),
	// 	Type: to.Ptr("Microsoft.Web/sites/workflows"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows/stateful1"),
	// 	Kind: to.Ptr("Stateful"),
	// 	Location: to.Ptr("USAAnywhere"),
	// 	Properties: &armappservice.WorkflowEnvelopeProperties{
	// 		Files: map[string]any{
	// 			"connections.json": map[string]any{
	// 				"managedApiConnections":map[string]any{
	// 					"office365":map[string]any{
	// 						"api":map[string]any{
	// 							"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/brazilsouth/managedApis/office365",
	// 						},
	// 						"authentication":map[string]any{
	// 							"type": "Raw",
	// 							"parameter": "@appsetting('office365-connectionKey')",
	// 							"scheme": "Key",
	// 						},
	// 						"connection":map[string]any{
	// 							"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/connections/office365-1",
	// 						},
	// 						"connectionRuntimeUrl": "string",
	// 					},
	// 				},
	// 			},
	// 			"workflow.json": map[string]any{
	// 				"definition":map[string]any{
	// 					"$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
	// 					"actions":map[string]any{
	// 					},
	// 					"contentVersion": "1.0.0.0",
	// 					"outputs":map[string]any{
	// 					},
	// 					"parameters":map[string]any{
	// 					},
	// 					"triggers":map[string]any{
	// 					},
	// 				},
	// 			},
	// 		},
	// 		FlowState: to.Ptr(armappservice.WorkflowStateEnabled),
	// 		Health: &armappservice.WorkflowHealth{
	// 			State: to.Ptr(armappservice.WorkflowHealthStateHealthy),
	// 		},
	// 	},
	// }
}

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

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get workflow information by its ID for web site, or a deployment slot.
 *
 * @summary Get workflow information by its ID for web site, or a deployment slot.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWorkflow.json
 */
async function getAWorkflowSlot() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "testsite2";
  const slot = "staging";
  const workflowName = "stateful1";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.getInstanceWorkflowSlot(
    resourceGroupName,
    name,
    slot,
    workflowName,
  );
  console.log(result);
}

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.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetWorkflow.json
// this example is just showing the usage of "WebApps_GetInstanceWorkflowSlot" 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 WebSiteSlotResource created on azure
// for more information of creating WebSiteSlotResource, please refer to the document of WebSiteSlotResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "testsite2";
string slot = "staging";
ResourceIdentifier webSiteSlotResourceId = WebSiteSlotResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, slot);
WebSiteSlotResource webSiteSlot = client.GetWebSiteSlotResource(webSiteSlotResourceId);

// get the collection of this SiteSlotWorkflowResource
SiteSlotWorkflowCollection collection = webSiteSlot.GetSiteSlotWorkflows();

// invoke the operation
string workflowName = "stateful1";
NullableResponse<SiteSlotWorkflowResource> response = await collection.GetIfExistsAsync(workflowName);
SiteSlotWorkflowResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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
    WorkflowEnvelopeData 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 de exemplo

Código de status:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/testsite2/workflows/stateful1",
  "name": "testsite2/stateful1",
  "type": "Microsoft.Web/sites/workflows",
  "kind": "Stateful",
  "location": "USAAnywhere",
  "properties": {
    "files": {
      "workflow.json": {
        "definition": {
          "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
          "actions": {},
          "contentVersion": "1.0.0.0",
          "outputs": {},
          "parameters": {},
          "triggers": {}
        }
      },
      "connections.json": {
        "managedApiConnections": {
          "office365": {
            "api": {
              "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/brazilsouth/managedApis/office365"
            },
            "connection": {
              "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/connections/office365-1"
            },
            "connectionRuntimeUrl": "string",
            "authentication": {
              "type": "Raw",
              "scheme": "Key",
              "parameter": "@appsetting('office365-connectionKey')"
            }
          }
        }
      }
    },
    "flowState": "Enabled",
    "health": {
      "state": "Healthy"
    }
  }
}

Código de status:

404

Definições

Nome	Description
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
Details
Error	Modelo de erro.
ErrorEntity	Corpo da resposta de erro retornada da API.
Properties	Propriedades de fluxo de trabalho adicionais.
WorkflowEnvelope	Definição de propriedades de fluxo de trabalho.
WorkflowHealth	Representa a integridade do fluxo de trabalho.
WorkflowHealthState	Obtém ou define o estado de integridade do fluxo de trabalho.
WorkflowState	O estado do fluxo de trabalho.

DefaultErrorResponse

Objeto

Resposta de erro do Serviço de Aplicativo.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Objeto

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

Error

Objeto

Modelo de erro.

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

ErrorEntity

Objeto

Corpo da resposta de erro retornada da API.

Nome	Tipo	Description
code	string	Código de erro básico.
details	ErrorEntity[]	Detalhes do erro.
extendedCode	string	Tipo de erro.
innerErrors	ErrorEntity[]	Erros internos.
message	string	Todos os detalhes do erro.
messageTemplate	string	Modelo de mensagem.
parameters	string[]	Parâmetros para o modelo.
target	string	O destino do erro.

Properties

Objeto

Propriedades de fluxo de trabalho adicionais.

Nome	Tipo	Description
files	object	Obtém ou define os arquivos.
flowState	WorkflowState	Obtém ou define o estado do fluxo de trabalho.
health	WorkflowHealth	Obtém ou define a integridade do fluxo de trabalho.

WorkflowEnvelope

Objeto

Definição de propriedades de fluxo de trabalho.

Nome	Tipo	Description
id	string	A ID do recurso.
kind	string	O tipo de recurso.
location	string	O local do recurso.
name	string	Obtém o nome do recurso.
properties	Properties	Propriedades de fluxo de trabalho adicionais.
type	string	Obtém o tipo de recurso.

WorkflowHealth

Objeto

Representa a integridade do fluxo de trabalho.

Nome	Tipo	Description
error	ErrorEntity	Obtém ou define o erro de fluxo de trabalho.
state	WorkflowHealthState	Obtém ou define o estado de integridade do fluxo de trabalho.

WorkflowHealthState

Enumeração

Obtém ou define o estado de integridade do fluxo de trabalho.

Valor	Description
Healthy
NotSpecified
Unhealthy
Unknown

WorkflowState

Enumeração

O estado do fluxo de trabalho.

Valor	Description
Completed
Deleted
Disabled
Enabled
NotSpecified
Suspended