Fields - List By Type

Service:

Automation

API Version:

2023-11-01

Recupere uma lista de campos de um determinado tipo identificado pelo nome do módulo.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/types/{typeName}/fields?api-version=2023-11-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
automationAccountName	path	True	string	O nome da conta de automação.
moduleName	path	True	string	O nome do módulo.
resourceGroupName	path	True	string	Nome de um grupo de recursos do Azure. Regex pattern: ^[-\w\._]+$
subscriptionId	path	True	string	Obtém as credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
typeName	path	True	string	O nome do tipo.
api-version	query	True	string	Versão da API do cliente.

Respostas

Nome	Tipo	Description
200 OK	TypeFieldListResult	OK
Other Status Codes	ErrorResponse	Resposta de erro de automação que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get a list of fields of a given type

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyAutomationAccount/modules/MyModule/types/MyCustomType/fields?api-version=2023-11-01

Sample Response

Status code:

200

{
  "value": [
    {
      "name": "Name",
      "type": "System.String"
    },
    {
      "name": "Id",
      "type": "System.Integer"
    },
    {
      "name": "Details",
      "type": "MyModule.AnotherCustomType"
    }
  ]
}

Definições

Nome	Description
ErrorResponse	Resposta de erro de uma falha de operação
TypeField	Informações sobre um campo de um tipo.
TypeFieldListResult	O modelo de resposta para a operação de campos de lista.

ErrorResponse

Resposta de erro de uma falha de operação

Nome	Tipo	Description
code	string	Código do erro
message	string	Mensagem de erro indicando por que a operação falhou.

TypeField

Informações sobre um campo de um tipo.

Nome	Tipo	Description
name	string	Obtém ou define o nome do campo.
type	string	Obtém ou define o tipo do campo.

TypeFieldListResult

O modelo de resposta para a operação de campos de lista.

Nome	Tipo	Description
value	TypeField[]	Obtém ou define uma lista de campos.