Object Data Types - List Fields By Module And Type

Referencia

Service:: Automation

API Version:: 2023-11-01

Recupere una lista de campos de un tipo determinado identificado por el nombre del módulo.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
automationAccountName	path	True	string	Nombre de la cuenta de Automation.
moduleName	path	True	string	Nombre del módulo.
resourceGroupName	path	True	string	Nombre de un grupo de recursos de Azure. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Obtiene las credenciales de suscripción que identifican a la suscripción de Microsoft Azure de forma única. El identificador de suscripción forma parte del URI para cada llamada al servicio.
typeName	path	True	string	Nombre del tipo.
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	TypeFieldListResult	Aceptar
Other Status Codes	ErrorResponse	Respuesta de error de Automatización que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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/objectDataTypes/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"
    }
  ]
}

Definiciones

Nombre	Description
ErrorResponse	Respuesta de error de un error de operación
TypeField	Información sobre un campo de un tipo.
TypeFieldListResult	Modelo de respuesta para la operación de campos de lista.

ErrorResponse

Respuesta de error de un error de operación

Nombre	Tipo	Description
code	string	Código de error
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

TypeField

Información sobre un campo de un tipo.

Nombre	Tipo	Description
name	string	Obtiene o establece el nombre del campo.
type	string	Obtiene o establece el tipo del campo.

TypeFieldListResult

Modelo de respuesta para la operación de campos de lista.

Nombre	Tipo	Description
value	TypeField[]	Obtiene o establece una lista de campos.

Share via