Object Data Types - List Fields By Type

Service:

Automation

API Version:

2023-11-01

Retrieve a list of fields of a given type across all accessible modules.

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

URI Parameters

Name	In	Required	Type	Description
automationAccountName	path	True	string	The name of the automation account.
resourceGroupName	path	True	string	Name of an Azure Resource group. Regex pattern: ^[-\w\._]+$
subscriptionId	path	True	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
typeName	path	True	string	The name of type.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	TypeFieldListResult	OK
Other Status Codes	ErrorResponse	Automation error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get a list of fields of a given type across all accessible modules

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyAutomationAccount/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"
    }
  ]
}

Definitions

Name	Description
ErrorResponse	Error response of an operation failure
TypeField	Information about a field of a type.
TypeFieldListResult	The response model for the list fields operation.

ErrorResponse

Error response of an operation failure

Name	Type	Description
code	string	Error code
message	string	Error message indicating why the operation failed.

TypeField

Information about a field of a type.

Name	Type	Description
name	string	Gets or sets the name of the field.
type	string	Gets or sets the type of the field.

TypeFieldListResult

The response model for the list fields operation.

Name	Type	Description
value	TypeField[]	Gets or sets a list of fields.