Microsoft.Automation (stable:2024-10-23)

2024/12/09 • 172 new methods

AutomationAccount_Update (new)
Description :  Update an automation account.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update automation account. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets account update properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets account SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the SKU name of the account. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
family:
{
Description: Gets or sets the SKU family. ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryption:
{
Description: Set the encryption properties for the automation account ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyvaultUri:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of key used to encrypt data. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The key version of the key used to encrypt data. ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Encryption Key Source ,
Enum:
{
Microsoft.Automation: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: User identity used for CMK. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user identity used for CMK. It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
publicNetworkAccess:
{
Description: Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet ,
Required: False ,
}
boolean ,
disableLocalAuth:
{
Description: Indicates whether requests using non-AAD authentication are blocked ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the location of the resource. ,
Required: False ,
}
string ,
identity:
{
Description: Sets the identity property for automation account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Gets or sets the tags attached to the resource. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the automation account properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU of account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the SKU name of the account. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
family:
{
Description: Gets or sets the SKU family. ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
lastModifiedBy:
{
Description: Gets or sets the last modified by. ,
Required: False ,
}
string ,
state:
{
Description: Gets status of account. ,
Enum:
{
Ok: No description available. ,
Unavailable: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for the automation account ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyvaultUri:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of key used to encrypt data. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The key version of the key used to encrypt data. ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Encryption Key Source ,
Enum:
{
Microsoft.Automation: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: User identity used for CMK. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user identity used for CMK. It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
privateEndpointConnections:
{
Description: List of Automation operations supported by the Automation resource provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Gets the groupIds. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet ,
Required: False ,
}
boolean ,
disableLocalAuth:
{
Description: Indicates whether requests using non-AAD authentication are blocked ,
Required: False ,
}
boolean ,
automationHybridServiceUrl:
{
Description: URL of automation hybrid service which is used for hybrid worker on-boarding. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
AutomationAccount_CreateOrUpdate (new)
Description :  Create or update automation account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update automation account. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets account create or update properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets account SKU. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the SKU name of the account. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
family:
{
Description: Gets or sets the SKU family. ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryption:
{
Description: Set the encryption properties for the automation account ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyvaultUri:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of key used to encrypt data. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The key version of the key used to encrypt data. ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Encryption Key Source ,
Enum:
{
Microsoft.Automation: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: User identity used for CMK. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user identity used for CMK. It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
publicNetworkAccess:
{
Description: Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet ,
Required: False ,
}
boolean ,
disableLocalAuth:
{
Description: Indicates whether requests using non-AAD authentication are blocked ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: Gets or sets name of the resource. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the location of the resource. ,
Required: False ,
}
string ,
identity:
{
Description: Sets the identity property for automation account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Gets or sets the tags attached to the resource. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the automation account properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU of account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the SKU name of the account. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
family:
{
Description: Gets or sets the SKU family. ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
lastModifiedBy:
{
Description: Gets or sets the last modified by. ,
Required: False ,
}
string ,
state:
{
Description: Gets status of account. ,
Enum:
{
Ok: No description available. ,
Unavailable: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for the automation account ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyvaultUri:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of key used to encrypt data. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The key version of the key used to encrypt data. ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Encryption Key Source ,
Enum:
{
Microsoft.Automation: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: User identity used for CMK. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user identity used for CMK. It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
privateEndpointConnections:
{
Description: List of Automation operations supported by the Automation resource provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Gets the groupIds. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet ,
Required: False ,
}
boolean ,
disableLocalAuth:
{
Description: Indicates whether requests using non-AAD authentication are blocked ,
Required: False ,
}
boolean ,
automationHybridServiceUrl:
{
Description: URL of automation hybrid service which is used for hybrid worker on-boarding. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the automation account properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU of account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the SKU name of the account. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
family:
{
Description: Gets or sets the SKU family. ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
lastModifiedBy:
{
Description: Gets or sets the last modified by. ,
Required: False ,
}
string ,
state:
{
Description: Gets status of account. ,
Enum:
{
Ok: No description available. ,
Unavailable: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for the automation account ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyvaultUri:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of key used to encrypt data. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The key version of the key used to encrypt data. ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Encryption Key Source ,
Enum:
{
Microsoft.Automation: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: User identity used for CMK. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user identity used for CMK. It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
privateEndpointConnections:
{
Description: List of Automation operations supported by the Automation resource provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Gets the groupIds. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet ,
Required: False ,
}
boolean ,
disableLocalAuth:
{
Description: Indicates whether requests using non-AAD authentication are blocked ,
Required: False ,
}
boolean ,
automationHybridServiceUrl:
{
Description: URL of automation hybrid service which is used for hybrid worker on-boarding. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
AutomationAccount_Delete (new)
Description :  Delete an automation account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
AutomationAccount_Get (new)
Description :  Get information about an Automation Account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the automation account properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU of account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the SKU name of the account. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
family:
{
Description: Gets or sets the SKU family. ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
lastModifiedBy:
{
Description: Gets or sets the last modified by. ,
Required: False ,
}
string ,
state:
{
Description: Gets status of account. ,
Enum:
{
Ok: No description available. ,
Unavailable: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for the automation account ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyvaultUri:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of key used to encrypt data. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The key version of the key used to encrypt data. ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Encryption Key Source ,
Enum:
{
Microsoft.Automation: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: User identity used for CMK. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user identity used for CMK. It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
privateEndpointConnections:
{
Description: List of Automation operations supported by the Automation resource provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Gets the groupIds. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet ,
Required: False ,
}
boolean ,
disableLocalAuth:
{
Description: Indicates whether requests using non-AAD authentication are blocked ,
Required: False ,
}
boolean ,
automationHybridServiceUrl:
{
Description: URL of automation hybrid service which is used for hybrid worker on-boarding. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
AutomationAccount_ListByResourceGroup (new)
Description :  Retrieve a list of accounts within a given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets list of accounts. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the automation account properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU of account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the SKU name of the account. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
family:
{
Description: Gets or sets the SKU family. ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
lastModifiedBy:
{
Description: Gets or sets the last modified by. ,
Required: False ,
}
string ,
state:
{
Description: Gets status of account. ,
Enum:
{
Ok: No description available. ,
Unavailable: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for the automation account ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyvaultUri:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of key used to encrypt data. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The key version of the key used to encrypt data. ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Encryption Key Source ,
Enum:
{
Microsoft.Automation: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: User identity used for CMK. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user identity used for CMK. It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
privateEndpointConnections:
{
Description: List of Automation operations supported by the Automation resource provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Gets the groupIds. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet ,
Required: False ,
}
boolean ,
disableLocalAuth:
{
Description: Indicates whether requests using non-AAD authentication are blocked ,
Required: False ,
}
boolean ,
automationHybridServiceUrl:
{
Description: URL of automation hybrid service which is used for hybrid worker on-boarding. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
AutomationAccount_List (new)
Description :  Retrieve a list of accounts within a given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Automation/automationAccounts
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets list of accounts. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the automation account properties. ,
Required: False ,
}
{
sku:
{
Description: Gets or sets the SKU of account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the SKU name of the account. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
}
,
Required: True ,
}
enum ,
family:
{
Description: Gets or sets the SKU family. ,
Required: False ,
}
string ,
capacity:
{
Description: Gets or sets the SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
lastModifiedBy:
{
Description: Gets or sets the last modified by. ,
Required: False ,
}
string ,
state:
{
Description: Gets status of account. ,
Enum:
{
Ok: No description available. ,
Unavailable: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
encryption:
{
Description: Encryption properties for the automation account ,
Required: False ,
}
{
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyvaultUri:
{
Description: The URI of the key vault key used to encrypt data. ,
Required: False ,
}
string ,
keyName:
{
Description: The name of key used to encrypt data. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The key version of the key used to encrypt data. ,
Required: False ,
}
string ,
}
,
keySource:
{
Description: Encryption Key Source ,
Enum:
{
Microsoft.Automation: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: User identity used for CMK. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user identity used for CMK. It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
privateEndpointConnections:
{
Description: List of Automation operations supported by the Automation resource provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Gets the groupIds. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet ,
Required: False ,
}
boolean ,
disableLocalAuth:
{
Description: Indicates whether requests using non-AAD authentication are blocked ,
Required: False ,
}
boolean ,
automationHybridServiceUrl:
{
Description: URL of automation hybrid service which is used for hybrid worker on-boarding. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. The value must be an UUID. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Statistics_ListByAutomationAccount (new)
Description :  Retrieve the statistics for the account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/statistics
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of statistics. ,
Required: False ,
}
[
{
counterProperty:
{
Description: Gets the property value of the statistic. ,
Required: False ,
}
string ,
counterValue:
{
Description: Gets the value of the statistic. ,
Format: int64 ,
Required: False ,
}
integer ,
startTime:
{
Description: Gets the startTime of the statistic. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the endTime of the statistic. ,
Format: date-time ,
Required: False ,
}
string ,
id:
{
Description: Gets the id. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Usages_ListByAutomationAccount (new)
Description :  Retrieve the usage for the account id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/usages
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets usage. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the usage counter name. ,
Required: False ,
}
{
value:
{
Description: Gets or sets the usage counter name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Gets or sets the localized usage counter name. ,
Required: False ,
}
string ,
}
,
unit:
{
Description: Gets or sets the usage unit name. ,
Required: False ,
}
string ,
currentValue:
{
Description: Gets or sets the current usage value. ,
Format: double ,
Required: False ,
}
number ,
limit:
{
Description: Gets or sets max limit. -1 for unlimited ,
Format: int64 ,
Required: False ,
}
integer ,
throttleStatus:
{
Description: Gets or sets the throttle status. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Keys_ListByAutomationAccount (new)
Description :  Retrieve the automation keys for an account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/listKeys
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
keys:
{
Description: Lists the automation keys. ,
Required: False ,
}
[
{
KeyName:
{
Description: Automation key name. ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
Permissions:
{
Description: Automation key permissions. ,
Enum:
{
Read: No description available. ,
Full: No description available. ,
}
,
Required: False ,
}
enum ,
Value:
{
Description: Value of the Automation Key used for registration. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
AutomationAccount_ListDeletedRunbooks (new)
Description :  Retrieve the deleted runbooks for an automation account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/listDeletedRunbooks
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of deleted runbooks in automation account. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the runbook properties. ,
Required: False ,
}
{
runbookId:
{
Description: Gets or sets the Runbook Id. ,
Required: False ,
}
string ,
runbookType:
{
Description: Type of the runbook. ,
Required: False ,
}
string ,
runtime:
{
Description: Gets or sets runtime of the runbook. ,
Required: False ,
}
string ,
runtimeEnvironment:
{
Description: Environment of the runbook. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
deletionTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets name of the resource. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the location of the resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Certificate_Delete (new)
Description :  Delete the certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates/{certificateName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
certificateName:
{
Description: The name of certificate. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Certificate_Get (new)
Description :  Retrieve the certificate identified by certificate name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates/{certificateName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
certificateName:
{
Description: The name of certificate. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties of the certificate. ,
Required: False ,
}
{
thumbprint:
{
Description: Gets the thumbprint of the certificate. ,
Required: False ,
}
string ,
expiryTime:
{
Description: Gets the expiry time of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
isExportable:
{
Description: Gets the is exportable flag of the certificate. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Certificate_CreateOrUpdate (new)
Description :  Create a certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates/{certificateName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
certificateName:
{
Description: The parameters supplied to the create or update certificate operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the create or update certificate operation. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the certificate. ,
Required: True ,
}
string ,
properties:
{
Description: Gets or sets the properties of the certificate. ,
Required: True ,
}
{
base64Value:
{
Description: Gets or sets the base64 encoded value of the certificate. ,
Required: True ,
}
string ,
description:
{
Description: Gets or sets the description of the certificate. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Gets or sets the thumbprint of the certificate. ,
Required: False ,
}
string ,
isExportable:
{
Description: Gets or sets the is exportable flag of the certificate. ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the properties of the certificate. ,
Required: False ,
}
{
thumbprint:
{
Description: Gets the thumbprint of the certificate. ,
Required: False ,
}
string ,
expiryTime:
{
Description: Gets the expiry time of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
isExportable:
{
Description: Gets the is exportable flag of the certificate. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties of the certificate. ,
Required: False ,
}
{
thumbprint:
{
Description: Gets the thumbprint of the certificate. ,
Required: False ,
}
string ,
expiryTime:
{
Description: Gets the expiry time of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
isExportable:
{
Description: Gets the is exportable flag of the certificate. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Certificate_Update (new)
Description :  Update a certificate.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates/{certificateName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
certificateName:
{
Description: The parameters supplied to the update certificate operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the update certificate operation. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the certificate. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the properties of the certificate. ,
Required: False ,
}
{
description:
{
Description: Gets or sets the description of the certificate. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties of the certificate. ,
Required: False ,
}
{
thumbprint:
{
Description: Gets the thumbprint of the certificate. ,
Required: False ,
}
string ,
expiryTime:
{
Description: Gets the expiry time of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
isExportable:
{
Description: Gets the is exportable flag of the certificate. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Certificate_ListByAutomationAccount (new)
Description :  Retrieve a list of certificates.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of certificates. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the properties of the certificate. ,
Required: False ,
}
{
thumbprint:
{
Description: Gets the thumbprint of the certificate. ,
Required: False ,
}
string ,
expiryTime:
{
Description: Gets the expiry time of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
isExportable:
{
Description: Gets the is exportable flag of the certificate. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Connection_Delete (new)
Description :  Delete the connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections/{connectionName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name of connection. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Connection_Get (new)
Description :  Retrieve the connection identified by connection name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections/{connectionName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
connectionName:
{
Description: The name of connection. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties of the connection. ,
Required: False ,
}
{
connectionType:
{
Description: Gets or sets the connectionType of the connection. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the connection type. ,
Required: False ,
}
string ,
}
,
fieldDefinitionValues:
{
Description: Gets the field definition values of the connection. ,
Required: False ,
}
object ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Connection_CreateOrUpdate (new)
Description :  Create or update a connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections/{connectionName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
connectionName:
{
Description: The parameters supplied to the create or update connection operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the create or update connection operation. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the connection. ,
Required: True ,
}
string ,
properties:
{
Description: Gets or sets the properties of the connection. ,
Required: True ,
}
{
description:
{
Description: Gets or sets the description of the connection. ,
Required: False ,
}
string ,
connectionType:
{
Description: Gets or sets the connectionType of the connection. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the connection type. ,
Required: False ,
}
string ,
}
,
fieldDefinitionValues:
{
Description: Gets or sets the field definition properties of the connection. ,
Required: False ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the properties of the connection. ,
Required: False ,
}
{
connectionType:
{
Description: Gets or sets the connectionType of the connection. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the connection type. ,
Required: False ,
}
string ,
}
,
fieldDefinitionValues:
{
Description: Gets the field definition values of the connection. ,
Required: False ,
}
object ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties of the connection. ,
Required: False ,
}
{
connectionType:
{
Description: Gets or sets the connectionType of the connection. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the connection type. ,
Required: False ,
}
string ,
}
,
fieldDefinitionValues:
{
Description: Gets the field definition values of the connection. ,
Required: False ,
}
object ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Connection_Update (new)
Description :  Update a connection.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections/{connectionName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
connectionName:
{
Description: The parameters supplied to the update a connection operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the update a connection operation. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the connection. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the properties of the connection. ,
Required: False ,
}
{
description:
{
Description: Gets or sets the description of the connection. ,
Required: False ,
}
string ,
fieldDefinitionValues:
{
Description: Gets or sets the field definition values of the connection. ,
Required: False ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties of the connection. ,
Required: False ,
}
{
connectionType:
{
Description: Gets or sets the connectionType of the connection. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the connection type. ,
Required: False ,
}
string ,
}
,
fieldDefinitionValues:
{
Description: Gets the field definition values of the connection. ,
Required: False ,
}
object ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Connection_ListByAutomationAccount (new)
Description :  Retrieve a list of connections.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of connection. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the properties of the connection. ,
Required: False ,
}
{
connectionType:
{
Description: Gets or sets the connectionType of the connection. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the connection type. ,
Required: False ,
}
string ,
}
,
fieldDefinitionValues:
{
Description: Gets the field definition values of the connection. ,
Required: False ,
}
object ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ConnectionType_Delete (new)
Description :  Delete the connection type.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes/{connectionTypeName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
connectionTypeName:
{
Description: The name of connection type. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ConnectionType_Get (new)
Description :  Retrieve the connection type identified by connection type name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes/{connectionTypeName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
connectionTypeName:
{
Description: The name of connection type. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name of the connection type. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the properties of the connection type. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets a Boolean value to indicate if the connection type is global. ,
Required: False ,
}
boolean ,
fieldDefinitions:
{
Description: Gets the field definitions of the connection type. ,
Required: False ,
}
object ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ConnectionType_CreateOrUpdate (new)
Description :  Create a connection type.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes/{connectionTypeName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
connectionTypeName:
{
Description: The parameters supplied to the create or update connection type operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the create or update connection type operation. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the connection type. ,
Required: True ,
}
string ,
properties:
{
Description: Gets or sets the value of the connection type. ,
Required: True ,
}
{
isGlobal:
{
Description: Gets or sets a Boolean value to indicate if the connection type is global. ,
Required: False ,
}
boolean ,
fieldDefinitions:
{
Description: Gets or sets the field definitions of the connection type. ,
Required: True ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Gets the id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name of the connection type. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the properties of the connection type. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets a Boolean value to indicate if the connection type is global. ,
Required: False ,
}
boolean ,
fieldDefinitions:
{
Description: Gets the field definitions of the connection type. ,
Required: False ,
}
object ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ConnectionType_ListByAutomationAccount (new)
Description :  Retrieve a list of connection types.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of connection types. ,
Required: False ,
}
[
{
id:
{
Description: Gets the id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name of the connection type. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the properties of the connection type. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets a Boolean value to indicate if the connection type is global. ,
Required: False ,
}
boolean ,
fieldDefinitions:
{
Description: Gets the field definitions of the connection type. ,
Required: False ,
}
object ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Credential_Delete (new)
Description :  Delete the credential.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials/{credentialName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
credentialName:
{
Description: The name of credential. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Credential_Get (new)
Description :  Retrieve the credential identified by credential name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials/{credentialName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
credentialName:
{
Description: The name of credential. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties of the credential. ,
Required: False ,
}
{
userName:
{
Description: Gets the user name of the credential. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Credential_CreateOrUpdate (new)
Description :  Create a credential.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials/{credentialName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
credentialName:
{
Description: The parameters supplied to the create or update credential operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the create or update credential operation. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the credential. ,
Required: True ,
}
string ,
properties:
{
Description: Gets or sets the properties of the credential. ,
Required: True ,
}
{
userName:
{
Description: Gets or sets the user name of the credential. ,
Required: True ,
}
string ,
password:
{
Description: Gets or sets the password of the credential. ,
Required: True ,
}
string ,
description:
{
Description: Gets or sets the description of the credential. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the properties of the credential. ,
Required: False ,
}
{
userName:
{
Description: Gets the user name of the credential. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties of the credential. ,
Required: False ,
}
{
userName:
{
Description: Gets the user name of the credential. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Credential_Update (new)
Description :  Update a credential.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials/{credentialName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
credentialName:
{
Description: The parameters supplied to the Update credential operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the Update credential operation. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the credential. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the properties of the variable. ,
Required: False ,
}
{
userName:
{
Description: Gets or sets the user name of the credential. ,
Required: False ,
}
string ,
password:
{
Description: Gets or sets the password of the credential. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description of the credential. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties of the credential. ,
Required: False ,
}
{
userName:
{
Description: Gets the user name of the credential. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Credential_ListByAutomationAccount (new)
Description :  Retrieve a list of credentials.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of credentials. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the properties of the credential. ,
Required: False ,
}
{
userName:
{
Description: Gets the user name of the credential. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}
deletedAutomationAccounts_ListBySubscription (new)
Description :  Retrieve deleted automation account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Automation/deletedAutomationAccounts
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of deleted automation accounts. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the automation account properties. ,
Required: False ,
}
{
automationAccountResourceId:
{
Description: Gets or sets the Automation Account Resource Id. ,
Required: False ,
}
string ,
automationAccountId:
{
Description: Gets or sets the Automation Account Id. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the location of the resource. ,
Required: False ,
}
string ,
deletionTime:
{
Description: Gets the deletion time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets name of the resource. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the location of the resource. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DscConfiguration_Delete (new)
Description :  Delete the dsc configuration identified by configuration name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
configurationName:
{
Description: The configuration name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DscConfiguration_Get (new)
Description :  Retrieve the configuration identified by configuration name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
configurationName:
{
Description: The configuration name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
jobCount:
{
Description: Gets or sets the job count of the configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
parameters:
{
Description: Gets or sets the configuration parameters. ,
Required: False ,
}
object ,
source:
{
Description: Gets or sets the source. ,
Required: False ,
}
{
hash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
type:
{
Description: Gets or sets the content source type. ,
Enum:
{
embeddedContent: No description available. ,
uri: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Gets or sets the value of the content. This is based on the content source type. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
state:
{
Description: Gets or sets the state of the configuration. ,
Enum:
{
New: No description available. ,
Edit: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
logVerbose:
{
Description: Gets or sets verbose log option. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
nodeConfigurationCount:
{
Description: Gets the number of compiled node configurations. ,
Required: False ,
}
integer ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DscConfiguration_CreateOrUpdate (new)
Description :  Create the configuration identified by configuration name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
configurationName:
{
Description: The create or update parameters for configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The create or update parameters for configuration. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets configuration create or update properties. ,
Required: True ,
}
{
logVerbose:
{
Description: Gets or sets verbose log option. ,
Required: False ,
}
boolean ,
logProgress:
{
Description: Gets or sets progress log option. ,
Required: False ,
}
boolean ,
source:
{
Description: Gets or sets the source. ,
Required: True ,
}
{
hash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
type:
{
Description: Gets or sets the content source type. ,
Enum:
{
embeddedContent: No description available. ,
uri: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Gets or sets the value of the content. This is based on the content source type. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Gets or sets the configuration parameters. ,
Required: False ,
}
object ,
description:
{
Description: Gets or sets the description of the configuration. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets name of the resource. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
jobCount:
{
Description: Gets or sets the job count of the configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
parameters:
{
Description: Gets or sets the configuration parameters. ,
Required: False ,
}
object ,
source:
{
Description: Gets or sets the source. ,
Required: False ,
}
{
hash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
type:
{
Description: Gets or sets the content source type. ,
Enum:
{
embeddedContent: No description available. ,
uri: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Gets or sets the value of the content. This is based on the content source type. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
state:
{
Description: Gets or sets the state of the configuration. ,
Enum:
{
New: No description available. ,
Edit: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
logVerbose:
{
Description: Gets or sets verbose log option. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
nodeConfigurationCount:
{
Description: Gets the number of compiled node configurations. ,
Required: False ,
}
integer ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
jobCount:
{
Description: Gets or sets the job count of the configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
parameters:
{
Description: Gets or sets the configuration parameters. ,
Required: False ,
}
object ,
source:
{
Description: Gets or sets the source. ,
Required: False ,
}
{
hash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
type:
{
Description: Gets or sets the content source type. ,
Enum:
{
embeddedContent: No description available. ,
uri: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Gets or sets the value of the content. This is based on the content source type. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
state:
{
Description: Gets or sets the state of the configuration. ,
Enum:
{
New: No description available. ,
Edit: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
logVerbose:
{
Description: Gets or sets verbose log option. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
nodeConfigurationCount:
{
Description: Gets the number of compiled node configurations. ,
Required: False ,
}
integer ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DscConfiguration_Update (new)
Description :  Create the configuration identified by configuration name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
configurationName:
{
Description: The create or update parameters for configuration. ,
Required: True ,
}
string ,
parameters:
{
Description: The create or update parameters for configuration. ,
Required: False ,
}
{
properties:
{
Description: Gets or sets configuration create or update properties. ,
Required: False ,
}
{
logVerbose:
{
Description: Gets or sets verbose log option. ,
Required: False ,
}
boolean ,
logProgress:
{
Description: Gets or sets progress log option. ,
Required: False ,
}
boolean ,
source:
{
Description: Gets or sets the source. ,
Required: True ,
}
{
hash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
type:
{
Description: Gets or sets the content source type. ,
Enum:
{
embeddedContent: No description available. ,
uri: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Gets or sets the value of the content. This is based on the content source type. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Gets or sets the configuration parameters. ,
Required: False ,
}
object ,
description:
{
Description: Gets or sets the description of the configuration. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets name of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
jobCount:
{
Description: Gets or sets the job count of the configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
parameters:
{
Description: Gets or sets the configuration parameters. ,
Required: False ,
}
object ,
source:
{
Description: Gets or sets the source. ,
Required: False ,
}
{
hash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
type:
{
Description: Gets or sets the content source type. ,
Enum:
{
embeddedContent: No description available. ,
uri: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Gets or sets the value of the content. This is based on the content source type. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
state:
{
Description: Gets or sets the state of the configuration. ,
Enum:
{
New: No description available. ,
Edit: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
logVerbose:
{
Description: Gets or sets verbose log option. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
nodeConfigurationCount:
{
Description: Gets the number of compiled node configurations. ,
Required: False ,
}
integer ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DscConfiguration_GetContent (new)
Description :  Retrieve the configuration script identified by configuration name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}/content
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
configurationName:
{
Description: The configuration name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DscConfiguration_ListByAutomationAccount (new)
Description :  Retrieve a list of configurations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$skip:
{
Description: The number of rows to skip. ,
Required: False ,
}
integer ,
$top:
{
Description: The number of rows to take. ,
Required: False ,
}
integer ,
$inlinecount:
{
Description: Return total rows. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets the provisioning state of the configuration. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
jobCount:
{
Description: Gets or sets the job count of the configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
parameters:
{
Description: Gets or sets the configuration parameters. ,
Required: False ,
}
object ,
source:
{
Description: Gets or sets the source. ,
Required: False ,
}
{
hash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
type:
{
Description: Gets or sets the content source type. ,
Enum:
{
embeddedContent: No description available. ,
uri: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Gets or sets the value of the content. This is based on the content source type. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
state:
{
Description: Gets or sets the state of the configuration. ,
Enum:
{
New: No description available. ,
Edit: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
logVerbose:
{
Description: Gets or sets verbose log option. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
nodeConfigurationCount:
{
Description: Gets the number of compiled node configurations. ,
Required: False ,
}
integer ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
totalCount:
{
Description: Gets the total number of configurations matching filter criteria. ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
AgentRegistrationInformation_Get (new)
Description :  Retrieve the automation agent registration information.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
dscMetaConfiguration:
{
Description: Gets or sets the dsc meta configuration. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the dsc server endpoint. ,
Required: False ,
}
string ,
keys:
{
Description: Gets or sets the agent registration keys. ,
Required: False ,
}
{
primary:
{
Description: Gets or sets the primary key. ,
Required: False ,
}
string ,
secondary:
{
Description: Gets or sets the secondary key. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Gets or sets the id. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
AgentRegistrationInformation_RegenerateKey (new)
Description :  Regenerate a primary or secondary agent registration key
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation/regenerateKey
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
parameters:
{
Description: The name of the agent registration key to be regenerated ,
Required: True ,
}
{
keyName:
{
Description: Gets or sets the agent registration key name - primary or secondary. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
dscMetaConfiguration:
{
Description: Gets or sets the dsc meta configuration. ,
Required: False ,
}
string ,
endpoint:
{
Description: Gets or sets the dsc server endpoint. ,
Required: False ,
}
string ,
keys:
{
Description: Gets or sets the agent registration keys. ,
Required: False ,
}
{
primary:
{
Description: Gets or sets the primary key. ,
Required: False ,
}
string ,
secondary:
{
Description: Gets or sets the secondary key. ,
Required: False ,
}
string ,
}
,
id:
{
Description: Gets or sets the id. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DscNode_Delete (new)
Description :  Delete the dsc node identified by node id.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
nodeId:
{
Description: The node id. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DscNode_Get (new)
Description :  Retrieve the dsc node identified by node id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
nodeId:
{
Description: The node id. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a DscNode. ,
Required: False ,
}
{
lastSeen:
{
Description: Gets or sets the last seen time of the node. ,
Format: date-time ,
Required: False ,
}
string ,
registrationTime:
{
Description: Gets or sets the registration time of the node. ,
Format: date-time ,
Required: False ,
}
string ,
ip:
{
Description: Gets or sets the ip of the node. ,
Required: False ,
}
string ,
accountId:
{
Description: Gets or sets the account id of the node. ,
Required: False ,
}
string ,
nodeConfiguration:
{
Description: Gets or sets the configuration of the node. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the dsc node configuration. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Gets or sets the status of the node. ,
Required: False ,
}
string ,
nodeId:
{
Description: Gets or sets the node id. ,
Required: False ,
}
string ,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
totalCount:
{
Description: Gets the total number of records matching filter criteria. ,
Required: False ,
}
integer ,
extensionHandler:
{
Description: Gets or sets the list of extensionHandler properties for a Node. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the extension handler. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets the version of the extension handler. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DscNode_Update (new)
Description :  Update the dsc node.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
nodeId:
{
Description: Parameters supplied to the update dsc node. ,
Required: True ,
}
string ,
dscNodeUpdateParameters:
{
Description: Parameters supplied to the update dsc node. ,
Required: True ,
}
{
nodeId:
{
Description: Gets or sets the id of the dsc node. ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
nodeConfiguration:
{
Description: Gets or sets the configuration of the node. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the dsc node configuration. ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a DscNode. ,
Required: False ,
}
{
lastSeen:
{
Description: Gets or sets the last seen time of the node. ,
Format: date-time ,
Required: False ,
}
string ,
registrationTime:
{
Description: Gets or sets the registration time of the node. ,
Format: date-time ,
Required: False ,
}
string ,
ip:
{
Description: Gets or sets the ip of the node. ,
Required: False ,
}
string ,
accountId:
{
Description: Gets or sets the account id of the node. ,
Required: False ,
}
string ,
nodeConfiguration:
{
Description: Gets or sets the configuration of the node. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the dsc node configuration. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Gets or sets the status of the node. ,
Required: False ,
}
string ,
nodeId:
{
Description: Gets or sets the node id. ,
Required: False ,
}
string ,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
totalCount:
{
Description: Gets the total number of records matching filter criteria. ,
Required: False ,
}
integer ,
extensionHandler:
{
Description: Gets or sets the list of extensionHandler properties for a Node. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the extension handler. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets the version of the extension handler. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DscNode_ListByAutomationAccount (new)
Description :  Retrieve a list of dsc nodes.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$skip:
{
Description: The number of rows to skip. ,
Required: False ,
}
integer ,
$top:
{
Description: The number of rows to take. ,
Required: False ,
}
integer ,
$inlinecount:
{
Description: Return total rows. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of dsc nodes. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a DscNode. ,
Required: False ,
}
{
lastSeen:
{
Description: Gets or sets the last seen time of the node. ,
Format: date-time ,
Required: False ,
}
string ,
registrationTime:
{
Description: Gets or sets the registration time of the node. ,
Format: date-time ,
Required: False ,
}
string ,
ip:
{
Description: Gets or sets the ip of the node. ,
Required: False ,
}
string ,
accountId:
{
Description: Gets or sets the account id of the node. ,
Required: False ,
}
string ,
nodeConfiguration:
{
Description: Gets or sets the configuration of the node. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the dsc node configuration. ,
Required: False ,
}
string ,
}
,
status:
{
Description: Gets or sets the status of the node. ,
Required: False ,
}
string ,
nodeId:
{
Description: Gets or sets the node id. ,
Required: False ,
}
string ,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
totalCount:
{
Description: Gets the total number of records matching filter criteria. ,
Required: False ,
}
integer ,
extensionHandler:
{
Description: Gets or sets the list of extensionHandler properties for a Node. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the extension handler. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets the version of the extension handler. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
totalCount:
{
Description: Gets the total number of nodes matching filter criteria. ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NodeReports_ListByNode (new)
Description :  Retrieve the Dsc node report list by node id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
nodeId:
{
Description: The parameters supplied to the list operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of dsc node reports. ,
Required: False ,
}
[
{
endTime:
{
Description: Gets or sets the end time of the node report. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the lastModifiedTime of the node report. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time of the node report. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the node report. ,
Required: False ,
}
string ,
reportId:
{
Description: Gets or sets the id of the node report. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the node report. ,
Required: False ,
}
string ,
refreshMode:
{
Description: Gets or sets the refreshMode of the node report. ,
Required: False ,
}
string ,
rebootRequested:
{
Description: Gets or sets the rebootRequested of the node report. ,
Required: False ,
}
string ,
reportFormatVersion:
{
Description: Gets or sets the reportFormatVersion of the node report. ,
Required: False ,
}
string ,
configurationVersion:
{
Description: Gets or sets the configurationVersion of the node report. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets the id. ,
Required: False ,
}
string ,
errors:
{
Description: Gets or sets the errors for the node report. ,
Required: False ,
}
[
{
errorSource:
{
Description: Gets or sets the source of the error. ,
Required: False ,
}
string ,
resourceId:
{
Description: Gets or sets the resource ID which generated the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
locale:
{
Description: Gets or sets the locale of the error. ,
Required: False ,
}
string ,
errorDetails:
{
Description: Gets or sets the error details. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Gets or sets the resource for the node report. ,
Required: False ,
}
[
{
resourceId:
{
Description: Gets or sets the ID of the resource. ,
Required: False ,
}
string ,
sourceInfo:
{
Description: Gets or sets the source info of the resource. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Gets or sets the Resource Navigation values for resources the resource depends on. ,
Required: False ,
}
[
{
resourceId:
{
Description: Gets or sets the ID of the resource to navigate to. ,
Required: False ,
}
string ,
}
,
]
,
moduleName:
{
Description: Gets or sets the module name of the resource. ,
Required: False ,
}
string ,
moduleVersion:
{
Description: Gets or sets the module version of the resource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
error:
{
Description: Gets or sets the error of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the resource. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Gets or sets the duration in seconds for the resource. ,
Format: double ,
Required: False ,
}
number ,
startDate:
{
Description: Gets or sets the start date of the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
metaConfiguration:
{
Description: Gets or sets the metaConfiguration of the node at the time of the report. ,
Required: False ,
}
{
configurationModeFrequencyMins:
{
Description: Gets or sets the ConfigurationModeFrequencyMins value of the meta configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
rebootNodeIfNeeded:
{
Description: Gets or sets the RebootNodeIfNeeded value of the meta configuration. ,
Required: False ,
}
boolean ,
configurationMode:
{
Description: Gets or sets the ConfigurationMode value of the meta configuration. ,
Required: False ,
}
string ,
actionAfterReboot:
{
Description: Gets or sets the ActionAfterReboot value of the meta configuration. ,
Required: False ,
}
string ,
certificateId:
{
Description: Gets or sets the CertificateId value of the meta configuration. ,
Required: False ,
}
string ,
refreshFrequencyMins:
{
Description: Gets or sets the RefreshFrequencyMins value of the meta configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
allowModuleOverwrite:
{
Description: Gets or sets the AllowModuleOverwrite value of the meta configuration. ,
Required: False ,
}
boolean ,
}
,
hostName:
{
Description: Gets or sets the hostname of the node that sent the report. ,
Required: False ,
}
string ,
iPV4Addresses:
{
Description: Gets or sets the IPv4 address of the node that sent the report. ,
Required: False ,
}
[
string ,
]
,
iPV6Addresses:
{
Description: Gets or sets the IPv6 address of the node that sent the report. ,
Required: False ,
}
[
string ,
]
,
numberOfResources:
{
Description: Gets or sets the number of resource in the node report. ,
Format: int32 ,
Required: False ,
}
integer ,
rawErrors:
{
Description: Gets or sets the unparsed errors for the node report. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NodeReports_Get (new)
Description :  Retrieve the Dsc node report data by node id and report id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports/{reportId}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
nodeId:
{
Description: The Dsc node id. ,
Required: True ,
}
string ,
reportId:
{
Description: The report id. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: Gets or sets the end time of the node report. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the lastModifiedTime of the node report. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time of the node report. ,
Format: date-time ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the node report. ,
Required: False ,
}
string ,
reportId:
{
Description: Gets or sets the id of the node report. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the node report. ,
Required: False ,
}
string ,
refreshMode:
{
Description: Gets or sets the refreshMode of the node report. ,
Required: False ,
}
string ,
rebootRequested:
{
Description: Gets or sets the rebootRequested of the node report. ,
Required: False ,
}
string ,
reportFormatVersion:
{
Description: Gets or sets the reportFormatVersion of the node report. ,
Required: False ,
}
string ,
configurationVersion:
{
Description: Gets or sets the configurationVersion of the node report. ,
Required: False ,
}
string ,
id:
{
Description: Gets or sets the id. ,
Required: False ,
}
string ,
errors:
{
Description: Gets or sets the errors for the node report. ,
Required: False ,
}
[
{
errorSource:
{
Description: Gets or sets the source of the error. ,
Required: False ,
}
string ,
resourceId:
{
Description: Gets or sets the resource ID which generated the error. ,
Required: False ,
}
string ,
errorCode:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
locale:
{
Description: Gets or sets the locale of the error. ,
Required: False ,
}
string ,
errorDetails:
{
Description: Gets or sets the error details. ,
Required: False ,
}
string ,
}
,
]
,
resources:
{
Description: Gets or sets the resource for the node report. ,
Required: False ,
}
[
{
resourceId:
{
Description: Gets or sets the ID of the resource. ,
Required: False ,
}
string ,
sourceInfo:
{
Description: Gets or sets the source info of the resource. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Gets or sets the Resource Navigation values for resources the resource depends on. ,
Required: False ,
}
[
{
resourceId:
{
Description: Gets or sets the ID of the resource to navigate to. ,
Required: False ,
}
string ,
}
,
]
,
moduleName:
{
Description: Gets or sets the module name of the resource. ,
Required: False ,
}
string ,
moduleVersion:
{
Description: Gets or sets the module version of the resource. ,
Required: False ,
}
string ,
resourceName:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
error:
{
Description: Gets or sets the error of the resource. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the resource. ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Gets or sets the duration in seconds for the resource. ,
Format: double ,
Required: False ,
}
number ,
startDate:
{
Description: Gets or sets the start date of the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
metaConfiguration:
{
Description: Gets or sets the metaConfiguration of the node at the time of the report. ,
Required: False ,
}
{
configurationModeFrequencyMins:
{
Description: Gets or sets the ConfigurationModeFrequencyMins value of the meta configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
rebootNodeIfNeeded:
{
Description: Gets or sets the RebootNodeIfNeeded value of the meta configuration. ,
Required: False ,
}
boolean ,
configurationMode:
{
Description: Gets or sets the ConfigurationMode value of the meta configuration. ,
Required: False ,
}
string ,
actionAfterReboot:
{
Description: Gets or sets the ActionAfterReboot value of the meta configuration. ,
Required: False ,
}
string ,
certificateId:
{
Description: Gets or sets the CertificateId value of the meta configuration. ,
Required: False ,
}
string ,
refreshFrequencyMins:
{
Description: Gets or sets the RefreshFrequencyMins value of the meta configuration. ,
Format: int32 ,
Required: False ,
}
integer ,
allowModuleOverwrite:
{
Description: Gets or sets the AllowModuleOverwrite value of the meta configuration. ,
Required: False ,
}
boolean ,
}
,
hostName:
{
Description: Gets or sets the hostname of the node that sent the report. ,
Required: False ,
}
string ,
iPV4Addresses:
{
Description: Gets or sets the IPv4 address of the node that sent the report. ,
Required: False ,
}
[
string ,
]
,
iPV6Addresses:
{
Description: Gets or sets the IPv6 address of the node that sent the report. ,
Required: False ,
}
[
string ,
]
,
numberOfResources:
{
Description: Gets or sets the number of resource in the node report. ,
Format: int32 ,
Required: False ,
}
integer ,
rawErrors:
{
Description: Gets or sets the unparsed errors for the node report. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NodeReports_GetContent (new)
Description :  Retrieve the Dsc node reports by node id and report id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports/{reportId}/content
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
nodeId:
{
Description: The Dsc node id. ,
Required: True ,
}
string ,
reportId:
{
Description: The report id. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DscNodeConfiguration_Delete (new)
Description :  Delete the Dsc node configurations by node configuration.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations/{nodeConfigurationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
nodeConfigurationName:
{
Description: The Dsc node configuration name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DscNodeConfiguration_Get (new)
Description :  Retrieve the Dsc node configurations by node configuration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations/{nodeConfigurationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
nodeConfigurationName:
{
Description: The Dsc node configuration name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the configuration properties. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets creation time. ,
Format: date-time ,
Required: False ,
}
string ,
configuration:
{
Description: Gets or sets the configuration of the node. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the Dsc configuration. ,
Required: False ,
}
string ,
}
,
source:
{
Description: Source of node configuration. ,
Required: False ,
}
string ,
nodeCount:
{
Description: Number of nodes with this node configuration assigned ,
Format: int64 ,
Required: False ,
}
integer ,
incrementNodeConfigurationBuild:
{
Description: If a new build version of NodeConfiguration is required. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DscNodeConfiguration_CreateOrUpdate (new)
Description :  Create the node configuration identified by node configuration name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations/{nodeConfigurationName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
nodeConfigurationName:
{
Description: The Dsc node configuration name. ,
Required: True ,
}
string ,
parameters:
{
Description: The create or update parameters for configuration. ,
Required: True ,
}
{
properties:
{
Description: Node configuration properties ,
Required: False ,
}
{
source:
{
Description: Gets or sets the source. ,
Required: True ,
}
{
hash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
type:
{
Description: Gets or sets the content source type. ,
Enum:
{
embeddedContent: No description available. ,
uri: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Gets or sets the value of the content. This is based on the content source type. ,
Required: False ,
}
string ,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
configuration:
{
Description: Gets or sets the configuration of the node. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the Dsc configuration. ,
Required: False ,
}
string ,
}
,
incrementNodeConfigurationBuild:
{
Description: If a new build version of NodeConfiguration is required. ,
Required: False ,
}
boolean ,
}
,
name:
{
Description: Name of the node configuration. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the configuration properties. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets creation time. ,
Format: date-time ,
Required: False ,
}
string ,
configuration:
{
Description: Gets or sets the configuration of the node. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the Dsc configuration. ,
Required: False ,
}
string ,
}
,
source:
{
Description: Source of node configuration. ,
Required: False ,
}
string ,
nodeCount:
{
Description: Number of nodes with this node configuration assigned ,
Format: int64 ,
Required: False ,
}
integer ,
incrementNodeConfigurationBuild:
{
Description: If a new build version of NodeConfiguration is required. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
DscNodeConfiguration_ListByAutomationAccount (new)
Description :  Retrieve a list of dsc node configurations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$skip:
{
Description: The number of rows to skip. ,
Required: False ,
}
integer ,
$top:
{
Description: The number of rows to take. ,
Required: False ,
}
integer ,
$inlinecount:
{
Description: Return total rows. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of Dsc node configurations. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the configuration properties. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets creation time. ,
Format: date-time ,
Required: False ,
}
string ,
configuration:
{
Description: Gets or sets the configuration of the node. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the Dsc configuration. ,
Required: False ,
}
string ,
}
,
source:
{
Description: Source of node configuration. ,
Required: False ,
}
string ,
nodeCount:
{
Description: Number of nodes with this node configuration assigned ,
Format: int64 ,
Required: False ,
}
integer ,
incrementNodeConfigurationBuild:
{
Description: If a new build version of NodeConfiguration is required. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
totalCount:
{
Description: Gets or sets the total rows in query. ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NodeCountInformation_Get (new)
Description :  Retrieve counts for Dsc Nodes.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodecounts/{countType}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
countType:
{
Description: The type of counts to retrieve ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets an array of counts ,
Required: False ,
}
[
{
name:
{
Description: Gets the name of a count type ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
count:
{
Description: Gets the count for the name ,
Required: False ,
}
integer ,
}
,
}
,
]
,
totalCount:
{
Description: Gets the total number of records matching countType criteria. ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridRunbookWorkers_Delete (new)
Description :  Delete a hybrid runbook worker.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}/hybridRunbookWorkers/{hybridRunbookWorkerId}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
hybridRunbookWorkerGroupName:
{
Description: The hybrid runbook worker group name ,
Required: True ,
}
string ,
hybridRunbookWorkerId:
{
Description: The hybrid runbook worker id ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridRunbookWorkers_Get (new)
Description :  Retrieve a hybrid runbook worker.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}/hybridRunbookWorkers/{hybridRunbookWorkerId}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
hybridRunbookWorkerGroupName:
{
Description: The hybrid runbook worker group name ,
Required: True ,
}
string ,
hybridRunbookWorkerId:
{
Description: The hybrid runbook worker id ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the hybrid worker group properties. ,
Required: False ,
}
{
ip:
{
Description: Gets or sets the assigned machine IP address. ,
Required: False ,
}
string ,
registeredDateTime:
{
Description: Gets or sets the registration time of the worker machine. ,
Format: date-time ,
Required: False ,
}
string ,
lastSeenDateTime:
{
Description: Last Heartbeat from the Worker ,
Format: date-time ,
Required: False ,
}
string ,
vmResourceId:
{
Description: Azure Resource Manager Id for a virtual machine. ,
Required: False ,
}
string ,
workerType:
{
Description: Type of the HybridWorker. ,
Enum:
{
HybridV1: No description available. ,
HybridV2: No description available. ,
}
,
Required: False ,
}
enum ,
workerName:
{
Description: Name of the HybridWorker. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridRunbookWorkers_Create (new)
Description :  Create a hybrid runbook worker.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}/hybridRunbookWorkers/{hybridRunbookWorkerId}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
hybridRunbookWorkerGroupName:
{
Description: The hybrid runbook worker group name ,
Required: True ,
}
string ,
hybridRunbookWorkerId:
{
Description: The hybrid runbook worker id ,
Required: True ,
}
string ,
HybridRunbookWorkerCreationParameters:
{
Description: The create or update parameters for hybrid runbook worker. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets hybrid runbook worker group create or update properties. ,
Required: False ,
}
{
vmResourceId:
{
Description: Azure Resource Manager Id for a virtual machine. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the hybrid worker group properties. ,
Required: False ,
}
{
ip:
{
Description: Gets or sets the assigned machine IP address. ,
Required: False ,
}
string ,
registeredDateTime:
{
Description: Gets or sets the registration time of the worker machine. ,
Format: date-time ,
Required: False ,
}
string ,
lastSeenDateTime:
{
Description: Last Heartbeat from the Worker ,
Format: date-time ,
Required: False ,
}
string ,
vmResourceId:
{
Description: Azure Resource Manager Id for a virtual machine. ,
Required: False ,
}
string ,
workerType:
{
Description: Type of the HybridWorker. ,
Enum:
{
HybridV1: No description available. ,
HybridV2: No description available. ,
}
,
Required: False ,
}
enum ,
workerName:
{
Description: Name of the HybridWorker. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the hybrid worker group properties. ,
Required: False ,
}
{
ip:
{
Description: Gets or sets the assigned machine IP address. ,
Required: False ,
}
string ,
registeredDateTime:
{
Description: Gets or sets the registration time of the worker machine. ,
Format: date-time ,
Required: False ,
}
string ,
lastSeenDateTime:
{
Description: Last Heartbeat from the Worker ,
Format: date-time ,
Required: False ,
}
string ,
vmResourceId:
{
Description: Azure Resource Manager Id for a virtual machine. ,
Required: False ,
}
string ,
workerType:
{
Description: Type of the HybridWorker. ,
Enum:
{
HybridV1: No description available. ,
HybridV2: No description available. ,
}
,
Required: False ,
}
enum ,
workerName:
{
Description: Name of the HybridWorker. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridRunbookWorkers_Patch (new)
Description :  Update a hybrid runbook worker.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}/hybridRunbookWorkers/{hybridRunbookWorkerId}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
hybridRunbookWorkerGroupName:
{
Description: The hybrid runbook worker group name ,
Required: True ,
}
string ,
hybridRunbookWorkerId:
{
Description: The hybrid runbook worker id ,
Required: True ,
}
string ,
HybridRunbookWorkerCreationParameters:
{
Description: The create or update parameters for hybrid runbook worker. ,
Required: False ,
}
{
properties:
{
Description: Gets or sets hybrid runbook worker group create or update properties. ,
Required: False ,
}
{
vmResourceId:
{
Description: Azure Resource Manager Id for a virtual machine. ,
Required: False ,
}
string ,
}
,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the hybrid worker group properties. ,
Required: False ,
}
{
ip:
{
Description: Gets or sets the assigned machine IP address. ,
Required: False ,
}
string ,
registeredDateTime:
{
Description: Gets or sets the registration time of the worker machine. ,
Format: date-time ,
Required: False ,
}
string ,
lastSeenDateTime:
{
Description: Last Heartbeat from the Worker ,
Format: date-time ,
Required: False ,
}
string ,
vmResourceId:
{
Description: Azure Resource Manager Id for a virtual machine. ,
Required: False ,
}
string ,
workerType:
{
Description: Type of the HybridWorker. ,
Enum:
{
HybridV1: No description available. ,
HybridV2: No description available. ,
}
,
Required: False ,
}
enum ,
workerName:
{
Description: Name of the HybridWorker. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridRunbookWorkers_Move (new)
Description :  Move a hybrid worker to a different group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}/hybridRunbookWorkers/{hybridRunbookWorkerId}/move
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
hybridRunbookWorkerGroupName:
{
Description: The hybrid runbook worker group name ,
Required: True ,
}
string ,
hybridRunbookWorkerId:
{
Description: The hybrid runbook worker id ,
Required: True ,
}
string ,
HybridRunbookWorkerMoveParameters:
{
Description: The hybrid runbook worker move parameters ,
Required: True ,
}
{
hybridRunbookWorkerGroupName:
{
Description: Gets or sets the target hybrid runbook worker group. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridRunbookWorkers_ListByHybridRunbookWorkerGroup (new)
Description :  Retrieve a list of hybrid runbook workers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}/hybridRunbookWorkers
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
hybridRunbookWorkerGroupName:
{
Description: The hybrid runbook worker group name ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of hybrid runbook workers. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the hybrid worker group properties. ,
Required: False ,
}
{
ip:
{
Description: Gets or sets the assigned machine IP address. ,
Required: False ,
}
string ,
registeredDateTime:
{
Description: Gets or sets the registration time of the worker machine. ,
Format: date-time ,
Required: False ,
}
string ,
lastSeenDateTime:
{
Description: Last Heartbeat from the Worker ,
Format: date-time ,
Required: False ,
}
string ,
vmResourceId:
{
Description: Azure Resource Manager Id for a virtual machine. ,
Required: False ,
}
string ,
workerType:
{
Description: Type of the HybridWorker. ,
Enum:
{
HybridV1: No description available. ,
HybridV2: No description available. ,
}
,
Required: False ,
}
enum ,
workerName:
{
Description: Name of the HybridWorker. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridRunbookWorkerGroup_Delete (new)
Description :  Delete a hybrid runbook worker group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
hybridRunbookWorkerGroupName:
{
Description: The hybrid runbook worker group name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridRunbookWorkerGroup_Get (new)
Description :  Retrieve a hybrid runbook worker group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
hybridRunbookWorkerGroupName:
{
Description: The hybrid runbook worker group name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the hybrid worker group properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the HybridWorkerGroup. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
credential:
{
Description: Sets the credential of a worker group. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the credential. ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridRunbookWorkerGroup_Create (new)
Description :  Create a hybrid runbook worker group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
hybridRunbookWorkerGroupName:
{
Description: The hybrid runbook worker group name ,
Required: True ,
}
string ,
HybridRunbookWorkerGroupCreationParameters:
{
Description: The create or update parameters for hybrid runbook worker group. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets hybrid runbook worker group create or update properties. ,
Required: False ,
}
{
credential:
{
Description: Sets the credential of a worker group. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the credential. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the hybrid worker group properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the HybridWorkerGroup. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
credential:
{
Description: Sets the credential of a worker group. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the credential. ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the hybrid worker group properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the HybridWorkerGroup. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
credential:
{
Description: Sets the credential of a worker group. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the credential. ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridRunbookWorkerGroup_Update (new)
Description :  Update a hybrid runbook worker group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
hybridRunbookWorkerGroupName:
{
Description: The hybrid runbook worker group name ,
Required: True ,
}
string ,
HybridRunbookWorkerGroupUpdationParameters:
{
Description: The hybrid runbook worker group ,
Required: True ,
}
{
properties:
{
Description: Gets or sets hybrid runbook worker group create or update properties. ,
Required: False ,
}
{
credential:
{
Description: Sets the credential of a worker group. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the credential. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the hybrid worker group properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the HybridWorkerGroup. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
credential:
{
Description: Sets the credential of a worker group. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the credential. ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
HybridRunbookWorkerGroup_ListByAutomationAccount (new)
Description :  Retrieve a list of hybrid runbook worker groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of hybrid runbook worker groups. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the hybrid worker group properties. ,
Required: False ,
}
{
groupType:
{
Description: Type of the HybridWorkerGroup. ,
Enum:
{
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
credential:
{
Description: Sets the credential of a worker group. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the credential. ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Job_GetOutput (new)
Description :  Retrieve the job output identified by job name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/output
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the job to be created. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Job_GetRunbookContent (new)
Description :  Retrieve the runbook content of the job identified by job name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/runbookContent
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Job_Suspend (new)
Description :  Suspend the job identified by job name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/suspend
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Job_Stop (new)
Description :  Stop the job identified by jobName.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/stop
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Job_Get (new)
Description :  Retrieve the job identified by job name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the job. ,
Required: False ,
}
{
runbook:
{
Description: Gets or sets the runbook. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
startedBy:
{
Description: Gets or sets the job started by. ,
Required: False ,
}
string ,
runOn:
{
Description: Gets or sets the runOn which specifies the group name where the job is to be executed. ,
Required: False ,
}
string ,
jobRuntimeEnvironment:
{
Description: Runtime Environment Property ,
Required: False ,
}
{
runtimeEnvironmentName:
{
Description: Name of Runtime Environment. ,
Required: False ,
}
string ,
}
,
jobId:
{
Description: Gets or sets the id of the job. ,
Format: uuid ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the job. ,
Enum:
{
New: No description available. ,
Activating: No description available. ,
Running: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Stopped: No description available. ,
Blocked: No description available. ,
Suspended: No description available. ,
Disconnected: No description available. ,
Suspending: No description available. ,
Stopping: No description available. ,
Resuming: No description available. ,
Removing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gets or sets the status details of the job. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
exception:
{
Description: Gets or sets the exception of the job. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
lastStatusModifiedTime:
{
Description: Gets or sets the last status modified time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the job. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The current provisioning state of the job. ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Suspended: No description available. ,
Processing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Job_Create (new)
Description :  Create a job of the runbook.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the create job operation. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the list of job properties. ,
Required: True ,
}
{
runbook:
{
Description: Gets or sets the runbook. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Gets or sets the parameters of the job. ,
Required: False ,
}
object ,
runOn:
{
Description: Gets or sets the runOn which specifies the group name where the job is to be executed. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the job. ,
Required: False ,
}
{
runbook:
{
Description: Gets or sets the runbook. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
startedBy:
{
Description: Gets or sets the job started by. ,
Required: False ,
}
string ,
runOn:
{
Description: Gets or sets the runOn which specifies the group name where the job is to be executed. ,
Required: False ,
}
string ,
jobRuntimeEnvironment:
{
Description: Runtime Environment Property ,
Required: False ,
}
{
runtimeEnvironmentName:
{
Description: Name of Runtime Environment. ,
Required: False ,
}
string ,
}
,
jobId:
{
Description: Gets or sets the id of the job. ,
Format: uuid ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the job. ,
Enum:
{
New: No description available. ,
Activating: No description available. ,
Running: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Stopped: No description available. ,
Blocked: No description available. ,
Suspended: No description available. ,
Disconnected: No description available. ,
Suspending: No description available. ,
Stopping: No description available. ,
Resuming: No description available. ,
Removing: No description available. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gets or sets the status details of the job. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
exception:
{
Description: Gets or sets the exception of the job. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
lastStatusModifiedTime:
{
Description: Gets or sets the last status modified time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the job. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The current provisioning state of the job. ,
Enum:
{
Failed: No description available. ,
Succeeded: No description available. ,
Suspended: No description available. ,
Processing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Job_ListByAutomationAccount (new)
Description :  Retrieve a list of jobs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of jobs. ,
Required: False ,
}
[
{
properties:
{
Description: Job properties. ,
Required: True ,
}
{
runbook:
{
Description: The runbook association. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
jobId:
{
Description: The id of the job. ,
Format: uuid ,
Required: False ,
}
string ,
startedBy:
{
Description: Gets or sets the job started by. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the job. ,
Enum:
{
New: No description available. ,
Activating: No description available. ,
Running: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
Stopped: No description available. ,
Blocked: No description available. ,
Suspended: No description available. ,
Disconnected: No description available. ,
Suspending: No description available. ,
Stopping: No description available. ,
Resuming: No description available. ,
Removing: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The last modified time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of a resource. ,
Required: False ,
}
string ,
jobRuntimeEnvironment:
{
Description: Runtime Environment Property ,
Required: False ,
}
{
runtimeEnvironmentName:
{
Description: Name of Runtime Environment. ,
Required: False ,
}
string ,
}
,
runOn:
{
Description: Specifies the runOn group name where the job was executed. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Job_Resume (new)
Description :  Resume the job identified by jobName.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/resume
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
JobStream_Get (new)
Description :  Retrieve the job stream identified by job stream id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/streams/{jobStreamId}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
jobStreamId:
{
Description: The job stream id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the id of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the id of the job stream. ,
Required: False ,
}
{
jobStreamId:
{
Description: Gets or sets the id of the job stream. ,
Required: False ,
}
string ,
time:
{
Description: Gets or sets the creation time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
streamType:
{
Description: Gets or sets the stream type. ,
Enum:
{
Progress: No description available. ,
Output: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Debug: No description available. ,
Verbose: No description available. ,
Any: No description available. ,
}
,
Required: False ,
}
enum ,
streamText:
{
Description: Gets or sets the stream text. ,
Required: False ,
}
string ,
summary:
{
Description: Gets or sets the summary. ,
Required: False ,
}
string ,
value:
{
Description: Gets or sets the values of the job stream. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
JobStream_ListByJob (new)
Description :  Retrieve a list of jobs streams identified by job name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/streams
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
jobName:
{
Description: The job name. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of job streams. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the id of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the id of the job stream. ,
Required: False ,
}
{
jobStreamId:
{
Description: Gets or sets the id of the job stream. ,
Required: False ,
}
string ,
time:
{
Description: Gets or sets the creation time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
streamType:
{
Description: Gets or sets the stream type. ,
Enum:
{
Progress: No description available. ,
Output: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Debug: No description available. ,
Verbose: No description available. ,
Any: No description available. ,
}
,
Required: False ,
}
enum ,
streamText:
{
Description: Gets or sets the stream text. ,
Required: False ,
}
string ,
summary:
{
Description: Gets or sets the summary. ,
Required: False ,
}
string ,
value:
{
Description: Gets or sets the values of the job stream. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
JobSchedule_Delete (new)
Description :  Delete the job schedule identified by job schedule name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobSchedules/{jobScheduleId}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
jobScheduleId:
{
Description: The job schedule name. ,
Format: uuid ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
JobSchedule_Get (new)
Description :  Retrieve the job schedule identified by job schedule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobSchedules/{jobScheduleId}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
jobScheduleId:
{
Description: The job schedule name. ,
Format: uuid ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the properties of the job schedule. ,
Required: False ,
}
{
jobScheduleId:
{
Description: Gets or sets the id of job schedule. ,
Required: False ,
}
string ,
schedule:
{
Description: Gets or sets the schedule. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the Schedule. ,
Required: False ,
}
string ,
}
,
runbook:
{
Description: Gets or sets the runbook. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
runOn:
{
Description: Gets or sets the hybrid worker group that the scheduled job should run on. ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the job schedule. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
JobSchedule_Create (new)
Description :  Create a job schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobSchedules/{jobScheduleId}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
jobScheduleId:
{
Description: The job schedule name. ,
Format: uuid ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the create job schedule operation. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the list of job schedule properties. ,
Required: True ,
}
{
schedule:
{
Description: Gets or sets the schedule. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the Schedule. ,
Required: False ,
}
string ,
}
,
runbook:
{
Description: Gets or sets the runbook. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
runOn:
{
Description: Gets or sets the hybrid worker group that the scheduled job should run on. ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets a list of job properties. ,
Required: False ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Gets the id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the properties of the job schedule. ,
Required: False ,
}
{
jobScheduleId:
{
Description: Gets or sets the id of job schedule. ,
Required: False ,
}
string ,
schedule:
{
Description: Gets or sets the schedule. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the Schedule. ,
Required: False ,
}
string ,
}
,
runbook:
{
Description: Gets or sets the runbook. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
runOn:
{
Description: Gets or sets the hybrid worker group that the scheduled job should run on. ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the job schedule. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
JobSchedule_ListByAutomationAccount (new)
Description :  Retrieve a list of job schedules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobSchedules
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of job schedules. ,
Required: False ,
}
[
{
id:
{
Description: Gets the id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name of the variable. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the properties of the job schedule. ,
Required: False ,
}
{
jobScheduleId:
{
Description: Gets or sets the id of job schedule. ,
Required: False ,
}
string ,
schedule:
{
Description: Gets or sets the schedule. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the Schedule. ,
Required: False ,
}
string ,
}
,
runbook:
{
Description: Gets or sets the runbook. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
runOn:
{
Description: Gets or sets the hybrid worker group that the scheduled job should run on. ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the job schedule. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
LinkedWorkspace_Get (new)
Description :  Retrieve the linked workspace for the account id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/linkedWorkspace
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets the id of the linked workspace. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Activity_Get (new)
Description :  Retrieve the activity in the module identified by module name and activity name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/activities/{activityName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
moduleName:
{
Description: The name of module. ,
Required: True ,
}
string ,
activityName:
{
Description: The name of activity. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name of the activity. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the properties of the activity. ,
Required: False ,
}
{
definition:
{
Description: Gets or sets the user name of the activity. ,
Required: False ,
}
string ,
parameterSets:
{
Description: Gets or sets the parameter sets of the activity. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the activity parameter set. ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the activity parameter set. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the activity parameter. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the activity parameter. ,
Required: False ,
}
string ,
isMandatory:
{
Description: Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional. ,
Required: False ,
}
boolean ,
isDynamic:
{
Description: Gets or sets a Boolean value that indicates true if the parameter is dynamic. ,
Required: False ,
}
boolean ,
position:
{
Description: Gets or sets the position of the activity parameter. ,
Format: int64 ,
Required: False ,
}
integer ,
valueFromPipeline:
{
Description: Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This setting is used if the cmdlet must access the complete input object. false indicates that the parameter cannot take values from the complete input object. ,
Required: False ,
}
boolean ,
valueFromPipelineByPropertyName:
{
Description: Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name. ,
Required: False ,
}
boolean ,
valueFromRemainingArguments:
{
Description: Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values. ,
Required: False ,
}
boolean ,
description:
{
Description: Gets or sets the description of the activity parameter. ,
Required: False ,
}
string ,
validationSet:
{
Description: Gets or sets the validation set of activity parameter. ,
Required: False ,
}
[
{
memberValue:
{
Description: Gets or sets the name of the activity parameter validation set member. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
outputTypes:
{
Description: Gets or sets the output types of the activity. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the activity output type. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the activity output type. ,
Required: False ,
}
string ,
}
,
]
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Activity_ListByModule (new)
Description :  Retrieve a list of activities in the module identified by module name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/activities
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
moduleName:
{
Description: The name of module. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of activities. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the id of the resource. ,
Required: False ,
}
string ,
name:
{
Description: Gets the name of the activity. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the properties of the activity. ,
Required: False ,
}
{
definition:
{
Description: Gets or sets the user name of the activity. ,
Required: False ,
}
string ,
parameterSets:
{
Description: Gets or sets the parameter sets of the activity. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the activity parameter set. ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the activity parameter set. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the activity parameter. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the activity parameter. ,
Required: False ,
}
string ,
isMandatory:
{
Description: Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional. ,
Required: False ,
}
boolean ,
isDynamic:
{
Description: Gets or sets a Boolean value that indicates true if the parameter is dynamic. ,
Required: False ,
}
boolean ,
position:
{
Description: Gets or sets the position of the activity parameter. ,
Format: int64 ,
Required: False ,
}
integer ,
valueFromPipeline:
{
Description: Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This setting is used if the cmdlet must access the complete input object. false indicates that the parameter cannot take values from the complete input object. ,
Required: False ,
}
boolean ,
valueFromPipelineByPropertyName:
{
Description: Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name. ,
Required: False ,
}
boolean ,
valueFromRemainingArguments:
{
Description: Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values. ,
Required: False ,
}
boolean ,
description:
{
Description: Gets or sets the description of the activity parameter. ,
Required: False ,
}
string ,
validationSet:
{
Description: Gets or sets the validation set of activity parameter. ,
Required: False ,
}
[
{
memberValue:
{
Description: Gets or sets the name of the activity parameter validation set member. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
outputTypes:
{
Description: Gets or sets the output types of the activity. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the activity output type. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the activity output type. ,
Required: False ,
}
string ,
}
,
]
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Module_Delete (new)
Description :  Delete the module by name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
moduleName:
{
Description: The module name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Module_Get (new)
Description :  Retrieve the module identified by module name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
moduleName:
{
Description: The module name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the module properties. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets the isGlobal flag of the module. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the module. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the module. ,
Format: int64 ,
Required: False ,
}
integer ,
activityCount:
{
Description: Gets or sets the activity count of the module. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the module. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the module. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the module. ,
Required: False ,
}
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
isComposite:
{
Description: Gets or sets type of module, if its composite or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Module_CreateOrUpdate (new)
Description :  Create or Update the module identified by module name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
moduleName:
{
Description: The name of module. ,
Required: True ,
}
string ,
parameters:
{
Description: The create or update parameters for module. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the module create properties. ,
Required: True ,
}
{
contentLink:
{
Description: Gets or sets the module content link. ,
Required: True ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets or sets name of the resource. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the module properties. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets the isGlobal flag of the module. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the module. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the module. ,
Format: int64 ,
Required: False ,
}
integer ,
activityCount:
{
Description: Gets or sets the activity count of the module. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the module. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the module. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the module. ,
Required: False ,
}
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
isComposite:
{
Description: Gets or sets type of module, if its composite or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the module properties. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets the isGlobal flag of the module. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the module. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the module. ,
Format: int64 ,
Required: False ,
}
integer ,
activityCount:
{
Description: Gets or sets the activity count of the module. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the module. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the module. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the module. ,
Required: False ,
}
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
isComposite:
{
Description: Gets or sets type of module, if its composite or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Module_Update (new)
Description :  Update the module identified by module name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
moduleName:
{
Description: The name of module. ,
Required: True ,
}
string ,
parameters:
{
Description: The update parameters for module. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the module update properties. ,
Required: False ,
}
{
contentLink:
{
Description: Gets or sets the module content link. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets or sets name of the resource. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the module properties. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets the isGlobal flag of the module. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the module. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the module. ,
Format: int64 ,
Required: False ,
}
integer ,
activityCount:
{
Description: Gets or sets the activity count of the module. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the module. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the module. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the module. ,
Required: False ,
}
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
isComposite:
{
Description: Gets or sets type of module, if its composite or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Module_ListByAutomationAccount (new)
Description :  Retrieve a list of modules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of modules. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the module properties. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets the isGlobal flag of the module. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the module. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the module. ,
Format: int64 ,
Required: False ,
}
integer ,
activityCount:
{
Description: Gets or sets the activity count of the module. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the module. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the module. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the module. ,
Required: False ,
}
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
isComposite:
{
Description: Gets or sets type of module, if its composite or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ObjectDataTypes_ListFieldsByModuleAndType (new)
Description :  Retrieve a list of fields of a given type identified by module name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/objectDataTypes/{typeName}/fields
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
moduleName:
{
Description: The name of module. ,
Required: True ,
}
string ,
typeName:
{
Description: The name of type. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of fields. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the field. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the field. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ObjectDataTypes_ListFieldsByType (new)
Description :  Retrieve a list of fields of a given type across all accessible modules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/objectDataTypes/{typeName}/fields
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
typeName:
{
Description: The name of type. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of fields. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the field. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the field. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Fields_ListByType (new)
Description :  Retrieve a list of fields of a given type identified by module name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/types/{typeName}/fields
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
moduleName:
{
Description: The name of module. ,
Required: True ,
}
string ,
typeName:
{
Description: The name of type. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of fields. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the field. ,
Required: False ,
}
string ,
type:
{
Description: Gets or sets the type of the field. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Operations_List (new)
Description :  Lists all of the available Automation REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Automation/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Automation operations supported by the Automation resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: Provider, Resource and Operation values ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Automation ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Runbooks, Jobs etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation. ,
Required: False ,
}
string ,
properties:
{
Description: Operation properties format. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Specification of the service. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Operation service specification. ,
Required: False ,
}
[
{
name:
{
Description: The name of the metric. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the metric. ,
Required: False ,
}
string ,
displayDescription:
{
Description: The description of the metric. ,
Required: False ,
}
string ,
unit:
{
Description: Units the metric to be displayed in. ,
Required: False ,
}
string ,
aggregationType:
{
Description: The aggregation type. ,
Required: False ,
}
string ,
dimensions:
{
Description: List of dimensions. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dimension. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the dimension. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
logSpecifications:
{
Description: Operation log specification. ,
Required: False ,
}
[
{
name:
{
Description: The name of the specification. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the specification. ,
Required: False ,
}
string ,
blobDuration:
{
Description: Duration of the blob. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
convertGraphRunbookContent (new)
Description :  Post operation to serialize or deserialize GraphRunbookContent
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/convertGraphRunbookContent
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: Input data describing the graphical runbook. ,
Required: True ,
}
{
rawContent:
{
Description: Raw graphical Runbook content. ,
Required: False ,
}
{
schemaVersion:
{
Description: Schema version of the serializer. ,
Required: False ,
}
string ,
runbookDefinition:
{
Description: Serialized Graphical runbook ,
Required: False ,
}
string ,
runbookType:
{
Description: Runbook Type ,
Enum:
{
GraphPowerShell: No description available. ,
GraphPowerShellWorkflow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
graphRunbookJson:
{
Description: Graphical Runbook content as JSON ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
rawContent:
{
Description: Raw graphical Runbook content. ,
Required: False ,
}
{
schemaVersion:
{
Description: Schema version of the serializer. ,
Required: False ,
}
string ,
runbookDefinition:
{
Description: Serialized Graphical runbook ,
Required: False ,
}
string ,
runbookType:
{
Description: Runbook Type ,
Enum:
{
GraphPowerShell: No description available. ,
GraphPowerShellWorkflow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
graphRunbookJson:
{
Description: Graphical Runbook content as JSON ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Package_Delete (new)
Description :  Delete the package by name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}/packages/{packageName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runtimeEnvironmentName:
{
Description: The name of the Runtime Environment. ,
Required: True ,
}
string ,
packageName:
{
Description: The Package name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Package_Get (new)
Description :  Retrieve the Package identified by Package name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}/packages/{packageName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runtimeEnvironmentName:
{
Description: The name of the Runtime Environment. ,
Required: True ,
}
string ,
packageName:
{
Description: The Package name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the Package properties. ,
Required: False ,
}
{
default:
{
Description: Gets or sets the isGlobal flag of the package. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the Package. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the Package. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Package. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the Package. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the Package. ,
Required: False ,
}
{
code:
{
Description: Package import error code. ,
Required: False ,
}
string ,
message:
{
Description: Package import error message. ,
Required: False ,
}
string ,
}
,
allOf:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Package_CreateOrUpdate (new)
Description :  Create or update the package identified by package name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}/packages/{packageName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runtimeEnvironmentName:
{
Description: The name of the Runtime Environment. ,
Required: True ,
}
string ,
packageName:
{
Description: The name of Package. ,
Required: True ,
}
string ,
parameters:
{
Description: The create or update parameters for Package. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the package create properties. ,
Required: True ,
}
{
contentLink:
{
Description: Gets or sets the package content link. ,
Required: True ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
}
,
allOf:
{
Description: The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' ,
Required: False ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: True ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the Package properties. ,
Required: False ,
}
{
default:
{
Description: Gets or sets the isGlobal flag of the package. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the Package. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the Package. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Package. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the Package. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the Package. ,
Required: False ,
}
{
code:
{
Description: Package import error code. ,
Required: False ,
}
string ,
message:
{
Description: Package import error message. ,
Required: False ,
}
string ,
}
,
allOf:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the Package properties. ,
Required: False ,
}
{
default:
{
Description: Gets or sets the isGlobal flag of the package. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the Package. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the Package. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Package. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the Package. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the Package. ,
Required: False ,
}
{
code:
{
Description: Package import error code. ,
Required: False ,
}
string ,
message:
{
Description: Package import error message. ,
Required: False ,
}
string ,
}
,
allOf:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Package_Update (new)
Description :  Update the Package identified by Package name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}/packages/{packageName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runtimeEnvironmentName:
{
Description: The name of the Runtime Environment. ,
Required: True ,
}
string ,
packageName:
{
Description: The name of Package. ,
Required: True ,
}
string ,
parameters:
{
Description: The update parameters for Package. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the package update properties. ,
Required: False ,
}
{
contentLink:
{
Description: Gets or sets the package content link. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
}
,
allOf:
{
Description: The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' ,
Required: False ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: True ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the Package properties. ,
Required: False ,
}
{
default:
{
Description: Gets or sets the isGlobal flag of the package. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the Package. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the Package. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Package. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the Package. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the Package. ,
Required: False ,
}
{
code:
{
Description: Package import error code. ,
Required: False ,
}
string ,
message:
{
Description: Package import error message. ,
Required: False ,
}
string ,
}
,
allOf:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Package_ListByRuntimeEnvironment (new)
Description :  Retrieve the a list of Packages
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}/packages
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runtimeEnvironmentName:
{
Description: The name of the Runtime Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: list of the Packages of the runtime environment. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the Package properties. ,
Required: False ,
}
{
default:
{
Description: Gets or sets the isGlobal flag of the package. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the Package. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the Package. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the Package. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the Package. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the Package. ,
Required: False ,
}
{
code:
{
Description: Package import error code. ,
Required: False ,
}
string ,
message:
{
Description: Package import error message. ,
Required: False ,
}
string ,
}
,
allOf:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_ListByAutomationAccount (new)
Description :  List all private endpoint connections on a Automation account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/privateEndpointConnections
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Gets the groupIds. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets a private endpoint connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Gets the groupIds. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Approve or reject a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Gets the groupIds. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Gets the groupIds. ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Connection State of the Private Endpoint Connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: False ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Any action that is required beyond basic workflow (approve/ reject/ disconnect) ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PrivateLinkResources_Automation (new)
Description :  Gets the private link resources that need to be created for Automation account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/privateLinkResources
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
Python2Package_Delete (new)
Description :  Delete the python 2 package by name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python2Packages/{packageName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
packageName:
{
Description: The python package name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Python2Package_Get (new)
Description :  Retrieve the python 2 package identified by package name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python2Packages/{packageName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
packageName:
{
Description: The python package name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the module properties. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets the isGlobal flag of the module. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the module. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the module. ,
Format: int64 ,
Required: False ,
}
integer ,
activityCount:
{
Description: Gets or sets the activity count of the module. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the module. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the module. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the module. ,
Required: False ,
}
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
isComposite:
{
Description: Gets or sets type of module, if its composite or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Python2Package_CreateOrUpdate (new)
Description :  Create or Update the python 2 package identified by package name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python2Packages/{packageName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
packageName:
{
Description: The name of python package. ,
Required: True ,
}
string ,
parameters:
{
Description: The create or update parameters for python package. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the module create properties. ,
Required: True ,
}
{
contentLink:
{
Description: Gets or sets the module content link. ,
Required: True ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
}
,
tags:
{
Description: Gets or sets the tags attached to the resource. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the module properties. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets the isGlobal flag of the module. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the module. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the module. ,
Format: int64 ,
Required: False ,
}
integer ,
activityCount:
{
Description: Gets or sets the activity count of the module. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the module. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the module. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the module. ,
Required: False ,
}
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
isComposite:
{
Description: Gets or sets type of module, if its composite or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the module properties. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets the isGlobal flag of the module. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the module. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the module. ,
Format: int64 ,
Required: False ,
}
integer ,
activityCount:
{
Description: Gets or sets the activity count of the module. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the module. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the module. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the module. ,
Required: False ,
}
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
isComposite:
{
Description: Gets or sets type of module, if its composite or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Python2Package_Update (new)
Description :  Update the python 2 package identified by package name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python2Packages/{packageName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
packageName:
{
Description: The name of python package. ,
Required: True ,
}
string ,
parameters:
{
Description: The update parameters for python package. ,
Required: True ,
}
{
tags:
{
Description: Gets or sets the tags attached to the resource. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the module properties. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets the isGlobal flag of the module. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the module. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the module. ,
Format: int64 ,
Required: False ,
}
integer ,
activityCount:
{
Description: Gets or sets the activity count of the module. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the module. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the module. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the module. ,
Required: False ,
}
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
isComposite:
{
Description: Gets or sets type of module, if its composite or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Python2Package_ListByAutomationAccount (new)
Description :  Retrieve a list of python 2 packages.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python2Packages
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of modules. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the module properties. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets the isGlobal flag of the module. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the module. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the module. ,
Format: int64 ,
Required: False ,
}
integer ,
activityCount:
{
Description: Gets or sets the activity count of the module. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the module. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the module. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the module. ,
Required: False ,
}
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
isComposite:
{
Description: Gets or sets type of module, if its composite or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Python3Package_Delete (new)
Description :  Delete the python 3 package by name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python3Packages/{packageName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
packageName:
{
Description: The python package name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Python3Package_Get (new)
Description :  Retrieve the python 3 package identified by package name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python3Packages/{packageName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
packageName:
{
Description: The python package name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the module properties. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets the isGlobal flag of the module. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the module. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the module. ,
Format: int64 ,
Required: False ,
}
integer ,
activityCount:
{
Description: Gets or sets the activity count of the module. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the module. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the module. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the module. ,
Required: False ,
}
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
isComposite:
{
Description: Gets or sets type of module, if its composite or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Python3Package_CreateOrUpdate (new)
Description :  Create or Update the python 3 package identified by package name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python3Packages/{packageName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
packageName:
{
Description: The name of python package. ,
Required: True ,
}
string ,
parameters:
{
Description: The create or update parameters for python package. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the module create properties. ,
Required: True ,
}
{
contentLink:
{
Description: Gets or sets the module content link. ,
Required: True ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
}
,
tags:
{
Description: Gets or sets the tags attached to the resource. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the module properties. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets the isGlobal flag of the module. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the module. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the module. ,
Format: int64 ,
Required: False ,
}
integer ,
activityCount:
{
Description: Gets or sets the activity count of the module. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the module. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the module. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the module. ,
Required: False ,
}
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
isComposite:
{
Description: Gets or sets type of module, if its composite or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the module properties. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets the isGlobal flag of the module. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the module. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the module. ,
Format: int64 ,
Required: False ,
}
integer ,
activityCount:
{
Description: Gets or sets the activity count of the module. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the module. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the module. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the module. ,
Required: False ,
}
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
isComposite:
{
Description: Gets or sets type of module, if its composite or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Python3Package_Update (new)
Description :  Update the python 3 package identified by package name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python3Packages/{packageName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
packageName:
{
Description: The name of python package. ,
Required: True ,
}
string ,
parameters:
{
Description: The update parameters for python package. ,
Required: True ,
}
{
tags:
{
Description: Gets or sets the tags attached to the resource. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the module properties. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets the isGlobal flag of the module. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the module. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the module. ,
Format: int64 ,
Required: False ,
}
integer ,
activityCount:
{
Description: Gets or sets the activity count of the module. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the module. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the module. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the module. ,
Required: False ,
}
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
isComposite:
{
Description: Gets or sets type of module, if its composite or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Python3Package_ListByAutomationAccount (new)
Description :  Retrieve a list of python 3 packages.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python3Packages
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of modules. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the module properties. ,
Required: False ,
}
{
isGlobal:
{
Description: Gets or sets the isGlobal flag of the module. ,
Required: False ,
}
boolean ,
version:
{
Description: Gets or sets the version of the module. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: Gets or sets the size in bytes of the module. ,
Format: int64 ,
Required: False ,
}
integer ,
activityCount:
{
Description: Gets or sets the activity count of the module. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: Gets or sets the provisioning state of the module. ,
Enum:
{
Created: No description available. ,
Creating: No description available. ,
StartingImportModuleRunbook: No description available. ,
RunningImportModuleRunbook: No description available. ,
ContentRetrieved: No description available. ,
ContentDownloaded: No description available. ,
ContentValidated: No description available. ,
ConnectionTypeImported: No description available. ,
ContentStored: No description available. ,
ModuleDataStored: No description available. ,
ActivitiesStored: No description available. ,
ModuleImportRunbookComplete: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
contentLink:
{
Description: Gets or sets the contentLink of the module. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
error:
{
Description: Gets or sets the error info of the module. ,
Required: False ,
}
{
code:
{
Description: Gets or sets the error code. ,
Required: False ,
}
string ,
message:
{
Description: Gets or sets the error message. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
isComposite:
{
Description: Gets or sets type of module, if its composite or not. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
RunbookDraft_GetContent (new)
Description :  Retrieve the content of runbook draft identified by runbook name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/content
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The runbook name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
RunbookDraft_ReplaceContent (new)
Description :  Replaces the runbook draft content.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/content
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The runbook name. ,
Required: True ,
}
string ,
runbookContent:
{
Description: The runbook draft content. ,
Required: True ,
}
object ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
RunbookDraft_Get (new)
Description :  Retrieve the runbook draft identified by runbook name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The runbook name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
inEdit:
{
Description: Gets or sets whether runbook is in edit mode. ,
Required: False ,
}
boolean ,
draftContentLink:
{
Description: Gets or sets the draft runbook content link. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time of the runbook draft. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time of the runbook draft. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the runbook draft parameters. ,
Required: False ,
}
object ,
outputTypes:
{
Description: Gets or sets the runbook output types. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Runbook_Publish (new)
Description :  Publish runbook draft.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/publish
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The parameters supplied to the publish runbook operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
RunbookDraft_UndoEdit (new)
Description :  Undo draft edit to last known published state identified by runbook name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/undoEdit
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The runbook name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
statusCode:
{
Enum:
{
Continue: No description available. ,
SwitchingProtocols: No description available. ,
OK: No description available. ,
Created: No description available. ,
Accepted: No description available. ,
NonAuthoritativeInformation: No description available. ,
NoContent: No description available. ,
ResetContent: No description available. ,
PartialContent: No description available. ,
MultipleChoices: No description available. ,
Ambiguous: No description available. ,
MovedPermanently: No description available. ,
Moved: No description available. ,
Found: No description available. ,
Redirect: No description available. ,
SeeOther: No description available. ,
RedirectMethod: No description available. ,
NotModified: No description available. ,
UseProxy: No description available. ,
Unused: No description available. ,
TemporaryRedirect: No description available. ,
RedirectKeepVerb: No description available. ,
BadRequest: No description available. ,
Unauthorized: No description available. ,
PaymentRequired: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
MethodNotAllowed: No description available. ,
NotAcceptable: No description available. ,
ProxyAuthenticationRequired: No description available. ,
RequestTimeout: No description available. ,
Conflict: No description available. ,
Gone: No description available. ,
LengthRequired: No description available. ,
PreconditionFailed: No description available. ,
RequestEntityTooLarge: No description available. ,
RequestUriTooLong: No description available. ,
UnsupportedMediaType: No description available. ,
RequestedRangeNotSatisfiable: No description available. ,
ExpectationFailed: No description available. ,
UpgradeRequired: No description available. ,
InternalServerError: No description available. ,
NotImplemented: No description available. ,
BadGateway: No description available. ,
ServiceUnavailable: No description available. ,
GatewayTimeout: No description available. ,
HttpVersionNotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
requestId:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Runbook_GetContent (new)
Description :  Retrieve the content of runbook identified by runbook name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/content
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The runbook name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Runbook_Get (new)
Description :  Retrieve the runbook identified by runbook name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The runbook name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the runbook properties. ,
Required: False ,
}
{
runtimeEnvironment:
{
Description: Runtime Environment of the runbook execution. ,
Required: False ,
}
string ,
runbookType:
{
Description: Gets or sets the type of the runbook. ,
Enum:
{
Script: No description available. ,
Graph: No description available. ,
PowerShellWorkflow: No description available. ,
PowerShell: No description available. ,
GraphPowerShellWorkflow: No description available. ,
GraphPowerShell: No description available. ,
Python2: No description available. ,
Python3: No description available. ,
Python: No description available. ,
PowerShell72: No description available. ,
}
,
Required: False ,
}
enum ,
publishContentLink:
{
Description: Gets or sets the published runbook content link. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
state:
{
Description: Gets or sets the state of the runbook. ,
Enum:
{
New: No description available. ,
Edit: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
logVerbose:
{
Description: Gets or sets verbose log option. ,
Required: False ,
}
boolean ,
logProgress:
{
Description: Gets or sets progress log option. ,
Required: False ,
}
boolean ,
logActivityTrace:
{
Description: Gets or sets the option to log activity trace of the runbook. ,
Format: int32 ,
Required: False ,
}
integer ,
jobCount:
{
Description: Gets or sets the job count of the runbook. ,
Format: int32 ,
Required: False ,
}
integer ,
parameters:
{
Description: Gets or sets the runbook parameters. ,
Required: False ,
}
object ,
outputTypes:
{
Description: Gets or sets the runbook output types. ,
Required: False ,
}
[
string ,
]
,
draft:
{
Description: Gets or sets the draft runbook properties. ,
Required: False ,
}
{
inEdit:
{
Description: Gets or sets whether runbook is in edit mode. ,
Required: False ,
}
boolean ,
draftContentLink:
{
Description: Gets or sets the draft runbook content link. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time of the runbook draft. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time of the runbook draft. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the runbook draft parameters. ,
Required: False ,
}
object ,
outputTypes:
{
Description: Gets or sets the runbook output types. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Gets or sets the provisioning state of the runbook. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedBy:
{
Description: Gets or sets the last modified by. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Runbook_CreateOrUpdate (new)
Description :  Create the runbook identified by runbook name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The runbook name. ,
Required: True ,
}
string ,
parameters:
{
Description: The create or update parameters for runbook. Provide either content link for a published runbook or draft, not both. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets runbook create or update properties. ,
Required: True ,
}
{
logVerbose:
{
Description: Gets or sets verbose log option. ,
Required: False ,
}
boolean ,
logProgress:
{
Description: Gets or sets progress log option. ,
Required: False ,
}
boolean ,
runtimeEnvironment:
{
Description: Environment of the runbook. ,
Required: False ,
}
string ,
runbookType:
{
Description: Gets or sets the type of the runbook. ,
Enum:
{
Script: No description available. ,
Graph: No description available. ,
PowerShellWorkflow: No description available. ,
PowerShell: No description available. ,
GraphPowerShellWorkflow: No description available. ,
GraphPowerShell: No description available. ,
Python2: No description available. ,
Python3: No description available. ,
Python: No description available. ,
PowerShell72: No description available. ,
}
,
Required: True ,
}
enum ,
draft:
{
Description: Gets or sets the draft runbook properties. ,
Required: False ,
}
{
inEdit:
{
Description: Gets or sets whether runbook is in edit mode. ,
Required: False ,
}
boolean ,
draftContentLink:
{
Description: Gets or sets the draft runbook content link. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time of the runbook draft. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time of the runbook draft. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the runbook draft parameters. ,
Required: False ,
}
object ,
outputTypes:
{
Description: Gets or sets the runbook output types. ,
Required: False ,
}
[
string ,
]
,
}
,
publishContentLink:
{
Description: Gets or sets the published runbook content link. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
description:
{
Description: Gets or sets the description of the runbook. ,
Required: False ,
}
string ,
logActivityTrace:
{
Description: Gets or sets the activity-level tracing options of the runbook. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the runbook properties. ,
Required: False ,
}
{
runtimeEnvironment:
{
Description: Runtime Environment of the runbook execution. ,
Required: False ,
}
string ,
runbookType:
{
Description: Gets or sets the type of the runbook. ,
Enum:
{
Script: No description available. ,
Graph: No description available. ,
PowerShellWorkflow: No description available. ,
PowerShell: No description available. ,
GraphPowerShellWorkflow: No description available. ,
GraphPowerShell: No description available. ,
Python2: No description available. ,
Python3: No description available. ,
Python: No description available. ,
PowerShell72: No description available. ,
}
,
Required: False ,
}
enum ,
publishContentLink:
{
Description: Gets or sets the published runbook content link. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
state:
{
Description: Gets or sets the state of the runbook. ,
Enum:
{
New: No description available. ,
Edit: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
logVerbose:
{
Description: Gets or sets verbose log option. ,
Required: False ,
}
boolean ,
logProgress:
{
Description: Gets or sets progress log option. ,
Required: False ,
}
boolean ,
logActivityTrace:
{
Description: Gets or sets the option to log activity trace of the runbook. ,
Format: int32 ,
Required: False ,
}
integer ,
jobCount:
{
Description: Gets or sets the job count of the runbook. ,
Format: int32 ,
Required: False ,
}
integer ,
parameters:
{
Description: Gets or sets the runbook parameters. ,
Required: False ,
}
object ,
outputTypes:
{
Description: Gets or sets the runbook output types. ,
Required: False ,
}
[
string ,
]
,
draft:
{
Description: Gets or sets the draft runbook properties. ,
Required: False ,
}
{
inEdit:
{
Description: Gets or sets whether runbook is in edit mode. ,
Required: False ,
}
boolean ,
draftContentLink:
{
Description: Gets or sets the draft runbook content link. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time of the runbook draft. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time of the runbook draft. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the runbook draft parameters. ,
Required: False ,
}
object ,
outputTypes:
{
Description: Gets or sets the runbook output types. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Gets or sets the provisioning state of the runbook. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedBy:
{
Description: Gets or sets the last modified by. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the runbook properties. ,
Required: False ,
}
{
runtimeEnvironment:
{
Description: Runtime Environment of the runbook execution. ,
Required: False ,
}
string ,
runbookType:
{
Description: Gets or sets the type of the runbook. ,
Enum:
{
Script: No description available. ,
Graph: No description available. ,
PowerShellWorkflow: No description available. ,
PowerShell: No description available. ,
GraphPowerShellWorkflow: No description available. ,
GraphPowerShell: No description available. ,
Python2: No description available. ,
Python3: No description available. ,
Python: No description available. ,
PowerShell72: No description available. ,
}
,
Required: False ,
}
enum ,
publishContentLink:
{
Description: Gets or sets the published runbook content link. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
state:
{
Description: Gets or sets the state of the runbook. ,
Enum:
{
New: No description available. ,
Edit: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
logVerbose:
{
Description: Gets or sets verbose log option. ,
Required: False ,
}
boolean ,
logProgress:
{
Description: Gets or sets progress log option. ,
Required: False ,
}
boolean ,
logActivityTrace:
{
Description: Gets or sets the option to log activity trace of the runbook. ,
Format: int32 ,
Required: False ,
}
integer ,
jobCount:
{
Description: Gets or sets the job count of the runbook. ,
Format: int32 ,
Required: False ,
}
integer ,
parameters:
{
Description: Gets or sets the runbook parameters. ,
Required: False ,
}
object ,
outputTypes:
{
Description: Gets or sets the runbook output types. ,
Required: False ,
}
[
string ,
]
,
draft:
{
Description: Gets or sets the draft runbook properties. ,
Required: False ,
}
{
inEdit:
{
Description: Gets or sets whether runbook is in edit mode. ,
Required: False ,
}
boolean ,
draftContentLink:
{
Description: Gets or sets the draft runbook content link. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time of the runbook draft. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time of the runbook draft. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the runbook draft parameters. ,
Required: False ,
}
object ,
outputTypes:
{
Description: Gets or sets the runbook output types. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Gets or sets the provisioning state of the runbook. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedBy:
{
Description: Gets or sets the last modified by. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Runbook_Update (new)
Description :  Update the runbook identified by runbook name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The runbook name. ,
Required: True ,
}
string ,
parameters:
{
Description: The update parameters for runbook. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the runbook update properties. ,
Required: False ,
}
{
description:
{
Description: Gets or sets the description of the runbook. ,
Required: False ,
}
string ,
logVerbose:
{
Description: Gets or sets verbose log option. ,
Required: False ,
}
boolean ,
logProgress:
{
Description: Gets or sets progress log option. ,
Required: False ,
}
boolean ,
logActivityTrace:
{
Description: Gets or sets the activity-level tracing options of the runbook. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
location:
{
Description: Gets or sets the location of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Gets or sets the tags attached to the resource. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the runbook properties. ,
Required: False ,
}
{
runtimeEnvironment:
{
Description: Runtime Environment of the runbook execution. ,
Required: False ,
}
string ,
runbookType:
{
Description: Gets or sets the type of the runbook. ,
Enum:
{
Script: No description available. ,
Graph: No description available. ,
PowerShellWorkflow: No description available. ,
PowerShell: No description available. ,
GraphPowerShellWorkflow: No description available. ,
GraphPowerShell: No description available. ,
Python2: No description available. ,
Python3: No description available. ,
Python: No description available. ,
PowerShell72: No description available. ,
}
,
Required: False ,
}
enum ,
publishContentLink:
{
Description: Gets or sets the published runbook content link. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
state:
{
Description: Gets or sets the state of the runbook. ,
Enum:
{
New: No description available. ,
Edit: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
logVerbose:
{
Description: Gets or sets verbose log option. ,
Required: False ,
}
boolean ,
logProgress:
{
Description: Gets or sets progress log option. ,
Required: False ,
}
boolean ,
logActivityTrace:
{
Description: Gets or sets the option to log activity trace of the runbook. ,
Format: int32 ,
Required: False ,
}
integer ,
jobCount:
{
Description: Gets or sets the job count of the runbook. ,
Format: int32 ,
Required: False ,
}
integer ,
parameters:
{
Description: Gets or sets the runbook parameters. ,
Required: False ,
}
object ,
outputTypes:
{
Description: Gets or sets the runbook output types. ,
Required: False ,
}
[
string ,
]
,
draft:
{
Description: Gets or sets the draft runbook properties. ,
Required: False ,
}
{
inEdit:
{
Description: Gets or sets whether runbook is in edit mode. ,
Required: False ,
}
boolean ,
draftContentLink:
{
Description: Gets or sets the draft runbook content link. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time of the runbook draft. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time of the runbook draft. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the runbook draft parameters. ,
Required: False ,
}
object ,
outputTypes:
{
Description: Gets or sets the runbook output types. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Gets or sets the provisioning state of the runbook. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedBy:
{
Description: Gets or sets the last modified by. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Runbook_Delete (new)
Description :  Delete the runbook by name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The runbook name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Runbook_ListByAutomationAccount (new)
Description :  Retrieve a list of runbooks.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of runbooks. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the runbook properties. ,
Required: False ,
}
{
runtimeEnvironment:
{
Description: Runtime Environment of the runbook execution. ,
Required: False ,
}
string ,
runbookType:
{
Description: Gets or sets the type of the runbook. ,
Enum:
{
Script: No description available. ,
Graph: No description available. ,
PowerShellWorkflow: No description available. ,
PowerShell: No description available. ,
GraphPowerShellWorkflow: No description available. ,
GraphPowerShell: No description available. ,
Python2: No description available. ,
Python3: No description available. ,
Python: No description available. ,
PowerShell72: No description available. ,
}
,
Required: False ,
}
enum ,
publishContentLink:
{
Description: Gets or sets the published runbook content link. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
state:
{
Description: Gets or sets the state of the runbook. ,
Enum:
{
New: No description available. ,
Edit: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
logVerbose:
{
Description: Gets or sets verbose log option. ,
Required: False ,
}
boolean ,
logProgress:
{
Description: Gets or sets progress log option. ,
Required: False ,
}
boolean ,
logActivityTrace:
{
Description: Gets or sets the option to log activity trace of the runbook. ,
Format: int32 ,
Required: False ,
}
integer ,
jobCount:
{
Description: Gets or sets the job count of the runbook. ,
Format: int32 ,
Required: False ,
}
integer ,
parameters:
{
Description: Gets or sets the runbook parameters. ,
Required: False ,
}
object ,
outputTypes:
{
Description: Gets or sets the runbook output types. ,
Required: False ,
}
[
string ,
]
,
draft:
{
Description: Gets or sets the draft runbook properties. ,
Required: False ,
}
{
inEdit:
{
Description: Gets or sets whether runbook is in edit mode. ,
Required: False ,
}
boolean ,
draftContentLink:
{
Description: Gets or sets the draft runbook content link. ,
Required: False ,
}
{
uri:
{
Description: Gets or sets the uri of content. ,
Required: False ,
}
string ,
contentHash:
{
Description: Gets or sets the hash. ,
Required: False ,
}
{
algorithm:
{
Description: Gets or sets the content hash algorithm used to hash the content. ,
Required: True ,
}
string ,
value:
{
Description: Gets or sets expected hash value of the content. ,
Required: True ,
}
string ,
}
,
version:
{
Description: Gets or sets the version of the content. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Gets or sets the creation time of the runbook draft. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time of the runbook draft. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the runbook draft parameters. ,
Required: False ,
}
object ,
outputTypes:
{
Description: Gets or sets the runbook output types. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Gets or sets the provisioning state of the runbook. ,
Enum:
{
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedBy:
{
Description: Gets or sets the last modified by. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
TestJobStreams_Get (new)
Description :  Retrieve a test job stream of the test job identified by runbook name and stream id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/streams/{jobStreamId}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The runbook name. ,
Required: True ,
}
string ,
jobStreamId:
{
Description: The job stream id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Gets or sets the id of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the id of the job stream. ,
Required: False ,
}
{
jobStreamId:
{
Description: Gets or sets the id of the job stream. ,
Required: False ,
}
string ,
time:
{
Description: Gets or sets the creation time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
streamType:
{
Description: Gets or sets the stream type. ,
Enum:
{
Progress: No description available. ,
Output: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Debug: No description available. ,
Verbose: No description available. ,
Any: No description available. ,
}
,
Required: False ,
}
enum ,
streamText:
{
Description: Gets or sets the stream text. ,
Required: False ,
}
string ,
summary:
{
Description: Gets or sets the summary. ,
Required: False ,
}
string ,
value:
{
Description: Gets or sets the values of the job stream. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
TestJobStreams_ListByTestJob (new)
Description :  Retrieve a list of test job streams identified by runbook name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/streams
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The runbook name. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of job streams. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the id of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the id of the job stream. ,
Required: False ,
}
{
jobStreamId:
{
Description: Gets or sets the id of the job stream. ,
Required: False ,
}
string ,
time:
{
Description: Gets or sets the creation time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
streamType:
{
Description: Gets or sets the stream type. ,
Enum:
{
Progress: No description available. ,
Output: No description available. ,
Warning: No description available. ,
Error: No description available. ,
Debug: No description available. ,
Verbose: No description available. ,
Any: No description available. ,
}
,
Required: False ,
}
enum ,
streamText:
{
Description: Gets or sets the stream text. ,
Required: False ,
}
string ,
summary:
{
Description: Gets or sets the summary. ,
Required: False ,
}
string ,
value:
{
Description: Gets or sets the values of the job stream. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
TestJob_Create (new)
Description :  Create a test job of the runbook.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The parameters supplied to the create test job operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the create test job operation. ,
Required: True ,
}
{
parameters:
{
Description: Gets or sets the parameters of the test job. ,
Required: False ,
}
object ,
runOn:
{
Description: Gets or sets the runOn which specifies the group name where the job is to be executed. ,
Required: False ,
}
string ,
runtimeEnvironment:
{
Description: The runtime Environment Name on which job needs to be tested ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
creationTime:
{
Description: Gets or sets the creation time of the test job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the test job. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Gets or sets the status details of the test job. ,
Required: False ,
}
string ,
runOn:
{
Description: Gets or sets the runOn which specifies the group name where the job is to be executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time of the test job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time of the test job. ,
Format: date-time ,
Required: False ,
}
string ,
exception:
{
Description: Gets or sets the exception of the test job. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time of the test job. ,
Format: date-time ,
Required: False ,
}
string ,
lastStatusModifiedTime:
{
Description: Gets or sets the last status modified time of the test job. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the test job. ,
Required: False ,
}
object ,
logActivityTrace:
{
Description: The activity-level tracing options of the runbook. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
TestJob_Get (new)
Description :  Retrieve the test job for the specified runbook.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The runbook name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
creationTime:
{
Description: Gets or sets the creation time of the test job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the test job. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Gets or sets the status details of the test job. ,
Required: False ,
}
string ,
runOn:
{
Description: Gets or sets the runOn which specifies the group name where the job is to be executed. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time of the test job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets or sets the end time of the test job. ,
Format: date-time ,
Required: False ,
}
string ,
exception:
{
Description: Gets or sets the exception of the test job. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time of the test job. ,
Format: date-time ,
Required: False ,
}
string ,
lastStatusModifiedTime:
{
Description: Gets or sets the last status modified time of the test job. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the test job. ,
Required: False ,
}
object ,
logActivityTrace:
{
Description: The activity-level tracing options of the runbook. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
TestJob_Resume (new)
Description :  Resume the test job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/resume
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The runbook name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
TestJob_Stop (new)
Description :  Stop the test job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/stop
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The runbook name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
TestJob_Suspend (new)
Description :  Suspend the test job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/suspend
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runbookName:
{
Description: The runbook name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
RuntimeEnvironments_Update (new)
Description :  Update an Runtime Environment.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runtimeEnvironmentName:
{
Description: The name of the Runtime Environment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Runtime Environment ,
Required: True ,
}
{
properties:
{
Description: Gets or sets Runtime update properties. ,
Required: False ,
}
{
defaultPackages:
{
Description: List of Default packages for Environment ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the Runtime Environment properties. ,
Required: False ,
}
{
runtime:
{
Description: Runtime properties. ,
Required: False ,
}
{
language:
{
Description: Language of Runtime Environment ,
Required: False ,
}
string ,
version:
{
Description: Version of Language ,
Required: False ,
}
string ,
}
,
defaultPackages:
{
Description: List of Default packages for Environment ,
Required: False ,
}
object ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
RuntimeEnvironments_Create (new)
Description :  Create or update Runtime Environment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runtimeEnvironmentName:
{
Description: The name of the Runtime Environment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create the runtime environment. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the Runtime Environment properties. ,
Required: False ,
}
{
runtime:
{
Description: Runtime properties. ,
Required: False ,
}
{
language:
{
Description: Language of Runtime Environment ,
Required: False ,
}
string ,
version:
{
Description: Version of Language ,
Required: False ,
}
string ,
}
,
defaultPackages:
{
Description: List of Default packages for Environment ,
Required: False ,
}
object ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the Runtime Environment properties. ,
Required: False ,
}
{
runtime:
{
Description: Runtime properties. ,
Required: False ,
}
{
language:
{
Description: Language of Runtime Environment ,
Required: False ,
}
string ,
version:
{
Description: Version of Language ,
Required: False ,
}
string ,
}
,
defaultPackages:
{
Description: List of Default packages for Environment ,
Required: False ,
}
object ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the Runtime Environment properties. ,
Required: False ,
}
{
runtime:
{
Description: Runtime properties. ,
Required: False ,
}
{
language:
{
Description: Language of Runtime Environment ,
Required: False ,
}
string ,
version:
{
Description: Version of Language ,
Required: False ,
}
string ,
}
,
defaultPackages:
{
Description: List of Default packages for Environment ,
Required: False ,
}
object ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
RuntimeEnvironments_Delete (new)
Description :  Delete the Runtime Environment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runtimeEnvironmentName:
{
Description: The name of the Runtime Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
RuntimeEnvironments_Get (new)
Description :  Get information about the Runtime Environment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
runtimeEnvironmentName:
{
Description: The name of the Runtime Environment. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the Runtime Environment properties. ,
Required: False ,
}
{
runtime:
{
Description: Runtime properties. ,
Required: False ,
}
{
language:
{
Description: Language of Runtime Environment ,
Required: False ,
}
string ,
version:
{
Description: Version of Language ,
Required: False ,
}
string ,
}
,
defaultPackages:
{
Description: List of Default packages for Environment ,
Required: False ,
}
object ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
RuntimeEnvironments_ListByAutomationAccount (new)
Description :  Retrieve a list of RuntimeEnvironments.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: list of RuntimeEnvironment. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the Runtime Environment properties. ,
Required: False ,
}
{
runtime:
{
Description: Runtime properties. ,
Required: False ,
}
{
language:
{
Description: Language of Runtime Environment ,
Required: False ,
}
string ,
version:
{
Description: Version of Language ,
Required: False ,
}
string ,
}
,
defaultPackages:
{
Description: List of Default packages for Environment ,
Required: False ,
}
object ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Resource system metadata. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Schedule_CreateOrUpdate (new)
Description :  Create a schedule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/schedules/{scheduleName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
scheduleName:
{
Description: The schedule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the create or update schedule operation. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the Schedule. ,
Required: True ,
}
string ,
properties:
{
Description: Gets or sets the list of schedule properties. ,
Required: True ,
}
{
description:
{
Description: Gets or sets the description of the schedule. ,
Required: False ,
}
string ,
startTime:
{
Description: Gets or sets the start time of the schedule. ,
Format: date-time ,
Required: True ,
}
string ,
expiryTime:
{
Description: Gets or sets the end time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Gets or sets the interval of the schedule. ,
Required: False ,
}
string ,
frequency:
{
Description: Gets or sets the frequency of the schedule. ,
Enum:
{
OneTime: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Week: No description available. ,
Month: No description available. ,
Minute: The minimum allowed interval for Minute schedules is 15 minutes. ,
}
,
Required: True ,
}
enum ,
timeZone:
{
Description: Gets or sets the time zone of the schedule. ,
Required: False ,
}
string ,
advancedSchedule:
{
Description: Gets or sets the AdvancedSchedule. ,
Required: False ,
}
{
weekDays:
{
Description: Days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Occurrences of days within a month. ,
Required: False ,
}
[
{
occurrence:
{
Description: Occurrence of the week within the month. Must be between 1 and 5 ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the properties of the schedule. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the start time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
startTimeOffsetMinutes:
{
Description: Gets the start time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
expiryTime:
{
Description: Gets or sets the end time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTimeOffsetMinutes:
{
Description: Gets or sets the expiry time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Gets or sets a value indicating whether this schedule is enabled. ,
Required: False ,
}
boolean ,
nextRun:
{
Description: Gets or sets the next run time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
nextRunOffsetMinutes:
{
Description: Gets or sets the next run time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
interval:
{
Description: Gets or sets the interval of the schedule. ,
Required: False ,
}
string ,
frequency:
{
Description: Gets or sets the frequency of the schedule. ,
Enum:
{
OneTime: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Week: No description available. ,
Month: No description available. ,
Minute: The minimum allowed interval for Minute schedules is 15 minutes. ,
}
,
Required: False ,
}
enum ,
timeZone:
{
Description: Gets or sets the time zone of the schedule. ,
Required: False ,
}
string ,
advancedSchedule:
{
Description: Gets or sets the advanced schedule. ,
Required: False ,
}
{
weekDays:
{
Description: Days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Occurrences of days within a month. ,
Required: False ,
}
[
{
occurrence:
{
Description: Occurrence of the week within the month. Must be between 1 and 5 ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties of the schedule. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the start time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
startTimeOffsetMinutes:
{
Description: Gets the start time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
expiryTime:
{
Description: Gets or sets the end time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTimeOffsetMinutes:
{
Description: Gets or sets the expiry time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Gets or sets a value indicating whether this schedule is enabled. ,
Required: False ,
}
boolean ,
nextRun:
{
Description: Gets or sets the next run time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
nextRunOffsetMinutes:
{
Description: Gets or sets the next run time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
interval:
{
Description: Gets or sets the interval of the schedule. ,
Required: False ,
}
string ,
frequency:
{
Description: Gets or sets the frequency of the schedule. ,
Enum:
{
OneTime: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Week: No description available. ,
Month: No description available. ,
Minute: The minimum allowed interval for Minute schedules is 15 minutes. ,
}
,
Required: False ,
}
enum ,
timeZone:
{
Description: Gets or sets the time zone of the schedule. ,
Required: False ,
}
string ,
advancedSchedule:
{
Description: Gets or sets the advanced schedule. ,
Required: False ,
}
{
weekDays:
{
Description: Days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Occurrences of days within a month. ,
Required: False ,
}
[
{
occurrence:
{
Description: Occurrence of the week within the month. Must be between 1 and 5 ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (409)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Schedule_Update (new)
Description :  Update the schedule identified by schedule name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/schedules/{scheduleName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
scheduleName:
{
Description: The schedule name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the update schedule operation. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the Schedule. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the list of schedule properties. ,
Required: False ,
}
{
description:
{
Description: Gets or sets the description of the schedule. ,
Required: False ,
}
string ,
isEnabled:
{
Description: Gets or sets a value indicating whether this schedule is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties of the schedule. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the start time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
startTimeOffsetMinutes:
{
Description: Gets the start time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
expiryTime:
{
Description: Gets or sets the end time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTimeOffsetMinutes:
{
Description: Gets or sets the expiry time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Gets or sets a value indicating whether this schedule is enabled. ,
Required: False ,
}
boolean ,
nextRun:
{
Description: Gets or sets the next run time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
nextRunOffsetMinutes:
{
Description: Gets or sets the next run time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
interval:
{
Description: Gets or sets the interval of the schedule. ,
Required: False ,
}
string ,
frequency:
{
Description: Gets or sets the frequency of the schedule. ,
Enum:
{
OneTime: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Week: No description available. ,
Month: No description available. ,
Minute: The minimum allowed interval for Minute schedules is 15 minutes. ,
}
,
Required: False ,
}
enum ,
timeZone:
{
Description: Gets or sets the time zone of the schedule. ,
Required: False ,
}
string ,
advancedSchedule:
{
Description: Gets or sets the advanced schedule. ,
Required: False ,
}
{
weekDays:
{
Description: Days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Occurrences of days within a month. ,
Required: False ,
}
[
{
occurrence:
{
Description: Occurrence of the week within the month. Must be between 1 and 5 ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Schedule_Get (new)
Description :  Retrieve the schedule identified by schedule name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/schedules/{scheduleName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
scheduleName:
{
Description: The schedule name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties of the schedule. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the start time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
startTimeOffsetMinutes:
{
Description: Gets the start time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
expiryTime:
{
Description: Gets or sets the end time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTimeOffsetMinutes:
{
Description: Gets or sets the expiry time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Gets or sets a value indicating whether this schedule is enabled. ,
Required: False ,
}
boolean ,
nextRun:
{
Description: Gets or sets the next run time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
nextRunOffsetMinutes:
{
Description: Gets or sets the next run time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
interval:
{
Description: Gets or sets the interval of the schedule. ,
Required: False ,
}
string ,
frequency:
{
Description: Gets or sets the frequency of the schedule. ,
Enum:
{
OneTime: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Week: No description available. ,
Month: No description available. ,
Minute: The minimum allowed interval for Minute schedules is 15 minutes. ,
}
,
Required: False ,
}
enum ,
timeZone:
{
Description: Gets or sets the time zone of the schedule. ,
Required: False ,
}
string ,
advancedSchedule:
{
Description: Gets or sets the advanced schedule. ,
Required: False ,
}
{
weekDays:
{
Description: Days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Occurrences of days within a month. ,
Required: False ,
}
[
{
occurrence:
{
Description: Occurrence of the week within the month. Must be between 1 and 5 ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Schedule_Delete (new)
Description :  Delete the schedule identified by schedule name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/schedules/{scheduleName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
scheduleName:
{
Description: The schedule name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Schedule_ListByAutomationAccount (new)
Description :  Retrieve a list of schedules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/schedules
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of schedules. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the properties of the schedule. ,
Required: False ,
}
{
startTime:
{
Description: Gets or sets the start time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
startTimeOffsetMinutes:
{
Description: Gets the start time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
expiryTime:
{
Description: Gets or sets the end time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTimeOffsetMinutes:
{
Description: Gets or sets the expiry time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Gets or sets a value indicating whether this schedule is enabled. ,
Required: False ,
}
boolean ,
nextRun:
{
Description: Gets or sets the next run time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
nextRunOffsetMinutes:
{
Description: Gets or sets the next run time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
interval:
{
Description: Gets or sets the interval of the schedule. ,
Required: False ,
}
string ,
frequency:
{
Description: Gets or sets the frequency of the schedule. ,
Enum:
{
OneTime: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Week: No description available. ,
Month: No description available. ,
Minute: The minimum allowed interval for Minute schedules is 15 minutes. ,
}
,
Required: False ,
}
enum ,
timeZone:
{
Description: Gets or sets the time zone of the schedule. ,
Required: False ,
}
string ,
advancedSchedule:
{
Description: Gets or sets the advanced schedule. ,
Required: False ,
}
{
weekDays:
{
Description: Days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Occurrences of days within a month. ,
Required: False ,
}
[
{
occurrence:
{
Description: Occurrence of the week within the month. Must be between 1 and 5 ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SoftwareUpdateConfigurations_Create (new)
Description :  Create a new software update configuration with the name given in the URI.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations/{softwareUpdateConfigurationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
softwareUpdateConfigurationName:
{
Description: The name of the software update configuration to be created. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
parameters:
{
Description: Request body. ,
Required: True ,
}
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Software update configuration properties. ,
Required: True ,
}
{
updateConfiguration:
{
Description: update specific properties for the Software update configuration ,
Required: True ,
}
{
operatingSystem:
{
Description: operating system of target machines ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
windows:
{
Description: Windows specific update configuration. ,
Required: False ,
}
{
includedUpdateClassifications:
{
Description: Update classification included in the software update configuration. A comma separated string with required values ,
Enum:
{
Unclassified: No description available. ,
Critical: No description available. ,
Security: No description available. ,
UpdateRollup: No description available. ,
FeaturePack: No description available. ,
ServicePack: No description available. ,
Definition: No description available. ,
Tools: No description available. ,
Updates: No description available. ,
}
,
Required: False ,
}
enum ,
excludedKbNumbers:
{
Description: KB numbers excluded from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
includedKbNumbers:
{
Description: KB numbers included from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
rebootSetting:
{
Description: Reboot setting for the software update configuration. ,
Required: False ,
}
string ,
}
,
linux:
{
Description: Linux specific update configuration. ,
Required: False ,
}
{
includedPackageClassifications:
{
Description: Update classifications included in the software update configuration. ,
Enum:
{
Unclassified: No description available. ,
Critical: No description available. ,
Security: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
excludedPackageNameMasks:
{
Description: packages excluded from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
includedPackageNameMasks:
{
Description: packages included from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
rebootSetting:
{
Description: Reboot setting for the software update configuration. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601 ,
Format: duration ,
Required: False ,
}
string ,
azureVirtualMachines:
{
Description: List of azure resource Ids for azure virtual machines targeted by the software update configuration. ,
Required: False ,
}
[
string ,
]
,
nonAzureComputerNames:
{
Description: List of names of non-azure machines targeted by the software update configuration. ,
Required: False ,
}
[
string ,
]
,
targets:
{
Description: Group targets for the software update configuration. ,
Required: False ,
}
{
azureQueries:
{
Description: List of Azure queries in the software update configuration. ,
Required: False ,
}
[
{
scope:
{
Description: List of Subscription or Resource Group ARM Ids. ,
Required: False ,
}
[
string ,
]
,
locations:
{
Description: List of locations to scope the query to. ,
Required: False ,
}
[
string ,
]
,
tagSettings:
{
Description: Tag settings for the VM. ,
Required: False ,
}
{
tags:
{
Description: Dictionary of tags with its list of values. ,
Required: False ,
}
object ,
filterOperator:
{
Description: Filter VMs by Any or All specified tags. ,
Enum:
{
All: No description available. ,
Any: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nonAzureQueries:
{
Description: List of non Azure queries in the software update configuration. ,
Required: False ,
}
[
{
functionAlias:
{
Description: Log Analytics Saved Search name. ,
Required: False ,
}
string ,
workspaceId:
{
Description: Workspace Id for Log Analytics in which the saved Search is resided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
scheduleInfo:
{
Description: Schedule information for the Software update configuration ,
Required: True ,
}
{
startTime:
{
Description: Gets or sets the start time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
startTimeOffsetMinutes:
{
Description: Gets the start time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
expiryTime:
{
Description: Gets or sets the end time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTimeOffsetMinutes:
{
Description: Gets or sets the expiry time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Gets or sets a value indicating whether this schedule is enabled. ,
Required: False ,
}
boolean ,
nextRun:
{
Description: Gets or sets the next run time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
nextRunOffsetMinutes:
{
Description: Gets or sets the next run time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
interval:
{
Description: Gets or sets the interval of the schedule. ,
Format: int64 ,
Required: False ,
}
integer ,
frequency:
{
Description: Gets or sets the frequency of the schedule. ,
Enum:
{
OneTime: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Week: No description available. ,
Month: No description available. ,
Minute: The minimum allowed interval for Minute schedules is 15 minutes. ,
}
,
Required: False ,
}
enum ,
timeZone:
{
Description: Gets or sets the time zone of the schedule. ,
Required: False ,
}
string ,
advancedSchedule:
{
Description: Gets or sets the advanced schedule. ,
Required: False ,
}
{
weekDays:
{
Description: Days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Occurrences of days within a month. ,
Required: False ,
}
[
{
occurrence:
{
Description: Occurrence of the week within the month. Must be between 1 and 5 ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the software update configuration, which only appears in the response. ,
Required: False ,
}
string ,
error:
{
Description: Details of provisioning error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Creation time of the resource, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: CreatedBy property, which only appears in the response. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last time resource was modified, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: LastModifiedBy property, which only appears in the response. ,
Required: False ,
}
string ,
tasks:
{
Description: Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTask:
{
Description: Pre task properties. ,
Required: False ,
}
{
parameters:
{
Description: Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
postTask:
{
Description: Post task properties. ,
Required: False ,
}
{
parameters:
{
Description: Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Software update configuration properties. ,
Required: True ,
}
{
updateConfiguration:
{
Description: update specific properties for the Software update configuration ,
Required: True ,
}
{
operatingSystem:
{
Description: operating system of target machines ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
windows:
{
Description: Windows specific update configuration. ,
Required: False ,
}
{
includedUpdateClassifications:
{
Description: Update classification included in the software update configuration. A comma separated string with required values ,
Enum:
{
Unclassified: No description available. ,
Critical: No description available. ,
Security: No description available. ,
UpdateRollup: No description available. ,
FeaturePack: No description available. ,
ServicePack: No description available. ,
Definition: No description available. ,
Tools: No description available. ,
Updates: No description available. ,
}
,
Required: False ,
}
enum ,
excludedKbNumbers:
{
Description: KB numbers excluded from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
includedKbNumbers:
{
Description: KB numbers included from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
rebootSetting:
{
Description: Reboot setting for the software update configuration. ,
Required: False ,
}
string ,
}
,
linux:
{
Description: Linux specific update configuration. ,
Required: False ,
}
{
includedPackageClassifications:
{
Description: Update classifications included in the software update configuration. ,
Enum:
{
Unclassified: No description available. ,
Critical: No description available. ,
Security: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
excludedPackageNameMasks:
{
Description: packages excluded from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
includedPackageNameMasks:
{
Description: packages included from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
rebootSetting:
{
Description: Reboot setting for the software update configuration. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601 ,
Format: duration ,
Required: False ,
}
string ,
azureVirtualMachines:
{
Description: List of azure resource Ids for azure virtual machines targeted by the software update configuration. ,
Required: False ,
}
[
string ,
]
,
nonAzureComputerNames:
{
Description: List of names of non-azure machines targeted by the software update configuration. ,
Required: False ,
}
[
string ,
]
,
targets:
{
Description: Group targets for the software update configuration. ,
Required: False ,
}
{
azureQueries:
{
Description: List of Azure queries in the software update configuration. ,
Required: False ,
}
[
{
scope:
{
Description: List of Subscription or Resource Group ARM Ids. ,
Required: False ,
}
[
string ,
]
,
locations:
{
Description: List of locations to scope the query to. ,
Required: False ,
}
[
string ,
]
,
tagSettings:
{
Description: Tag settings for the VM. ,
Required: False ,
}
{
tags:
{
Description: Dictionary of tags with its list of values. ,
Required: False ,
}
object ,
filterOperator:
{
Description: Filter VMs by Any or All specified tags. ,
Enum:
{
All: No description available. ,
Any: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nonAzureQueries:
{
Description: List of non Azure queries in the software update configuration. ,
Required: False ,
}
[
{
functionAlias:
{
Description: Log Analytics Saved Search name. ,
Required: False ,
}
string ,
workspaceId:
{
Description: Workspace Id for Log Analytics in which the saved Search is resided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
scheduleInfo:
{
Description: Schedule information for the Software update configuration ,
Required: True ,
}
{
startTime:
{
Description: Gets or sets the start time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
startTimeOffsetMinutes:
{
Description: Gets the start time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
expiryTime:
{
Description: Gets or sets the end time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTimeOffsetMinutes:
{
Description: Gets or sets the expiry time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Gets or sets a value indicating whether this schedule is enabled. ,
Required: False ,
}
boolean ,
nextRun:
{
Description: Gets or sets the next run time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
nextRunOffsetMinutes:
{
Description: Gets or sets the next run time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
interval:
{
Description: Gets or sets the interval of the schedule. ,
Format: int64 ,
Required: False ,
}
integer ,
frequency:
{
Description: Gets or sets the frequency of the schedule. ,
Enum:
{
OneTime: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Week: No description available. ,
Month: No description available. ,
Minute: The minimum allowed interval for Minute schedules is 15 minutes. ,
}
,
Required: False ,
}
enum ,
timeZone:
{
Description: Gets or sets the time zone of the schedule. ,
Required: False ,
}
string ,
advancedSchedule:
{
Description: Gets or sets the advanced schedule. ,
Required: False ,
}
{
weekDays:
{
Description: Days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Occurrences of days within a month. ,
Required: False ,
}
[
{
occurrence:
{
Description: Occurrence of the week within the month. Must be between 1 and 5 ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the software update configuration, which only appears in the response. ,
Required: False ,
}
string ,
error:
{
Description: Details of provisioning error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Creation time of the resource, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: CreatedBy property, which only appears in the response. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last time resource was modified, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: LastModifiedBy property, which only appears in the response. ,
Required: False ,
}
string ,
tasks:
{
Description: Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTask:
{
Description: Pre task properties. ,
Required: False ,
}
{
parameters:
{
Description: Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
postTask:
{
Description: Post task properties. ,
Required: False ,
}
{
parameters:
{
Description: Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Software update configuration properties. ,
Required: True ,
}
{
updateConfiguration:
{
Description: update specific properties for the Software update configuration ,
Required: True ,
}
{
operatingSystem:
{
Description: operating system of target machines ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
windows:
{
Description: Windows specific update configuration. ,
Required: False ,
}
{
includedUpdateClassifications:
{
Description: Update classification included in the software update configuration. A comma separated string with required values ,
Enum:
{
Unclassified: No description available. ,
Critical: No description available. ,
Security: No description available. ,
UpdateRollup: No description available. ,
FeaturePack: No description available. ,
ServicePack: No description available. ,
Definition: No description available. ,
Tools: No description available. ,
Updates: No description available. ,
}
,
Required: False ,
}
enum ,
excludedKbNumbers:
{
Description: KB numbers excluded from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
includedKbNumbers:
{
Description: KB numbers included from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
rebootSetting:
{
Description: Reboot setting for the software update configuration. ,
Required: False ,
}
string ,
}
,
linux:
{
Description: Linux specific update configuration. ,
Required: False ,
}
{
includedPackageClassifications:
{
Description: Update classifications included in the software update configuration. ,
Enum:
{
Unclassified: No description available. ,
Critical: No description available. ,
Security: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
excludedPackageNameMasks:
{
Description: packages excluded from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
includedPackageNameMasks:
{
Description: packages included from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
rebootSetting:
{
Description: Reboot setting for the software update configuration. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601 ,
Format: duration ,
Required: False ,
}
string ,
azureVirtualMachines:
{
Description: List of azure resource Ids for azure virtual machines targeted by the software update configuration. ,
Required: False ,
}
[
string ,
]
,
nonAzureComputerNames:
{
Description: List of names of non-azure machines targeted by the software update configuration. ,
Required: False ,
}
[
string ,
]
,
targets:
{
Description: Group targets for the software update configuration. ,
Required: False ,
}
{
azureQueries:
{
Description: List of Azure queries in the software update configuration. ,
Required: False ,
}
[
{
scope:
{
Description: List of Subscription or Resource Group ARM Ids. ,
Required: False ,
}
[
string ,
]
,
locations:
{
Description: List of locations to scope the query to. ,
Required: False ,
}
[
string ,
]
,
tagSettings:
{
Description: Tag settings for the VM. ,
Required: False ,
}
{
tags:
{
Description: Dictionary of tags with its list of values. ,
Required: False ,
}
object ,
filterOperator:
{
Description: Filter VMs by Any or All specified tags. ,
Enum:
{
All: No description available. ,
Any: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nonAzureQueries:
{
Description: List of non Azure queries in the software update configuration. ,
Required: False ,
}
[
{
functionAlias:
{
Description: Log Analytics Saved Search name. ,
Required: False ,
}
string ,
workspaceId:
{
Description: Workspace Id for Log Analytics in which the saved Search is resided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
scheduleInfo:
{
Description: Schedule information for the Software update configuration ,
Required: True ,
}
{
startTime:
{
Description: Gets or sets the start time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
startTimeOffsetMinutes:
{
Description: Gets the start time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
expiryTime:
{
Description: Gets or sets the end time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTimeOffsetMinutes:
{
Description: Gets or sets the expiry time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Gets or sets a value indicating whether this schedule is enabled. ,
Required: False ,
}
boolean ,
nextRun:
{
Description: Gets or sets the next run time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
nextRunOffsetMinutes:
{
Description: Gets or sets the next run time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
interval:
{
Description: Gets or sets the interval of the schedule. ,
Format: int64 ,
Required: False ,
}
integer ,
frequency:
{
Description: Gets or sets the frequency of the schedule. ,
Enum:
{
OneTime: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Week: No description available. ,
Month: No description available. ,
Minute: The minimum allowed interval for Minute schedules is 15 minutes. ,
}
,
Required: False ,
}
enum ,
timeZone:
{
Description: Gets or sets the time zone of the schedule. ,
Required: False ,
}
string ,
advancedSchedule:
{
Description: Gets or sets the advanced schedule. ,
Required: False ,
}
{
weekDays:
{
Description: Days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Occurrences of days within a month. ,
Required: False ,
}
[
{
occurrence:
{
Description: Occurrence of the week within the month. Must be between 1 and 5 ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the software update configuration, which only appears in the response. ,
Required: False ,
}
string ,
error:
{
Description: Details of provisioning error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Creation time of the resource, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: CreatedBy property, which only appears in the response. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last time resource was modified, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: LastModifiedBy property, which only appears in the response. ,
Required: False ,
}
string ,
tasks:
{
Description: Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTask:
{
Description: Pre task properties. ,
Required: False ,
}
{
parameters:
{
Description: Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
postTask:
{
Description: Post task properties. ,
Required: False ,
}
{
parameters:
{
Description: Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SoftwareUpdateConfigurations_GetByName (new)
Description :  Get a single software update configuration by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations/{softwareUpdateConfigurationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
softwareUpdateConfigurationName:
{
Description: The name of the software update configuration to be created. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
properties:
{
Description: Software update configuration properties. ,
Required: True ,
}
{
updateConfiguration:
{
Description: update specific properties for the Software update configuration ,
Required: True ,
}
{
operatingSystem:
{
Description: operating system of target machines ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
windows:
{
Description: Windows specific update configuration. ,
Required: False ,
}
{
includedUpdateClassifications:
{
Description: Update classification included in the software update configuration. A comma separated string with required values ,
Enum:
{
Unclassified: No description available. ,
Critical: No description available. ,
Security: No description available. ,
UpdateRollup: No description available. ,
FeaturePack: No description available. ,
ServicePack: No description available. ,
Definition: No description available. ,
Tools: No description available. ,
Updates: No description available. ,
}
,
Required: False ,
}
enum ,
excludedKbNumbers:
{
Description: KB numbers excluded from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
includedKbNumbers:
{
Description: KB numbers included from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
rebootSetting:
{
Description: Reboot setting for the software update configuration. ,
Required: False ,
}
string ,
}
,
linux:
{
Description: Linux specific update configuration. ,
Required: False ,
}
{
includedPackageClassifications:
{
Description: Update classifications included in the software update configuration. ,
Enum:
{
Unclassified: No description available. ,
Critical: No description available. ,
Security: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
excludedPackageNameMasks:
{
Description: packages excluded from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
includedPackageNameMasks:
{
Description: packages included from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
rebootSetting:
{
Description: Reboot setting for the software update configuration. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601 ,
Format: duration ,
Required: False ,
}
string ,
azureVirtualMachines:
{
Description: List of azure resource Ids for azure virtual machines targeted by the software update configuration. ,
Required: False ,
}
[
string ,
]
,
nonAzureComputerNames:
{
Description: List of names of non-azure machines targeted by the software update configuration. ,
Required: False ,
}
[
string ,
]
,
targets:
{
Description: Group targets for the software update configuration. ,
Required: False ,
}
{
azureQueries:
{
Description: List of Azure queries in the software update configuration. ,
Required: False ,
}
[
{
scope:
{
Description: List of Subscription or Resource Group ARM Ids. ,
Required: False ,
}
[
string ,
]
,
locations:
{
Description: List of locations to scope the query to. ,
Required: False ,
}
[
string ,
]
,
tagSettings:
{
Description: Tag settings for the VM. ,
Required: False ,
}
{
tags:
{
Description: Dictionary of tags with its list of values. ,
Required: False ,
}
object ,
filterOperator:
{
Description: Filter VMs by Any or All specified tags. ,
Enum:
{
All: No description available. ,
Any: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nonAzureQueries:
{
Description: List of non Azure queries in the software update configuration. ,
Required: False ,
}
[
{
functionAlias:
{
Description: Log Analytics Saved Search name. ,
Required: False ,
}
string ,
workspaceId:
{
Description: Workspace Id for Log Analytics in which the saved Search is resided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
scheduleInfo:
{
Description: Schedule information for the Software update configuration ,
Required: True ,
}
{
startTime:
{
Description: Gets or sets the start time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
startTimeOffsetMinutes:
{
Description: Gets the start time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
expiryTime:
{
Description: Gets or sets the end time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
expiryTimeOffsetMinutes:
{
Description: Gets or sets the expiry time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
isEnabled:
{
Description: Gets or sets a value indicating whether this schedule is enabled. ,
Required: False ,
}
boolean ,
nextRun:
{
Description: Gets or sets the next run time of the schedule. ,
Format: date-time ,
Required: False ,
}
string ,
nextRunOffsetMinutes:
{
Description: Gets or sets the next run time's offset in minutes. ,
Format: double ,
Required: False ,
}
number ,
interval:
{
Description: Gets or sets the interval of the schedule. ,
Format: int64 ,
Required: False ,
}
integer ,
frequency:
{
Description: Gets or sets the frequency of the schedule. ,
Enum:
{
OneTime: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Week: No description available. ,
Month: No description available. ,
Minute: The minimum allowed interval for Minute schedules is 15 minutes. ,
}
,
Required: False ,
}
enum ,
timeZone:
{
Description: Gets or sets the time zone of the schedule. ,
Required: False ,
}
string ,
advancedSchedule:
{
Description: Gets or sets the advanced schedule. ,
Required: False ,
}
{
weekDays:
{
Description: Days of the week that the job should execute on. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: Days of the month that the job should execute on. Must be between 1 and 31. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: Occurrences of days within a month. ,
Required: False ,
}
[
{
occurrence:
{
Description: Occurrence of the week within the month. Must be between 1 and 5 ,
Format: int32 ,
Required: False ,
}
integer ,
day:
{
Description: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. ,
Enum:
{
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
Sunday: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the software update configuration, which only appears in the response. ,
Required: False ,
}
string ,
error:
{
Description: Details of provisioning error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Creation time of the resource, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: CreatedBy property, which only appears in the response. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last time resource was modified, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: LastModifiedBy property, which only appears in the response. ,
Required: False ,
}
string ,
tasks:
{
Description: Tasks information for the Software update configuration. ,
Required: False ,
}
{
preTask:
{
Description: Pre task properties. ,
Required: False ,
}
{
parameters:
{
Description: Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
postTask:
{
Description: Post task properties. ,
Required: False ,
}
{
parameters:
{
Description: Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SoftwareUpdateConfigurations_Delete (new)
Description :  delete a specific software update configuration.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations/{softwareUpdateConfigurationName}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
softwareUpdateConfigurationName:
{
Description: The name of the software update configuration to be created. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SoftwareUpdateConfigurations_List (new)
Description :  Get all software update configurations for the account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: outer object returned when listing all software update configurations ,
Required: False ,
}
[
{
name:
{
Description: Name of the software update configuration. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the software update configuration ,
Required: False ,
}
string ,
properties:
{
Description: Software update configuration properties. ,
Required: True ,
}
{
updateConfiguration:
{
Description: Update specific properties of the software update configuration. ,
Required: False ,
}
{
operatingSystem:
{
Description: operating system of target machines ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
windows:
{
Description: Windows specific update configuration. ,
Required: False ,
}
{
includedUpdateClassifications:
{
Description: Update classification included in the software update configuration. A comma separated string with required values ,
Enum:
{
Unclassified: No description available. ,
Critical: No description available. ,
Security: No description available. ,
UpdateRollup: No description available. ,
FeaturePack: No description available. ,
ServicePack: No description available. ,
Definition: No description available. ,
Tools: No description available. ,
Updates: No description available. ,
}
,
Required: False ,
}
enum ,
excludedKbNumbers:
{
Description: KB numbers excluded from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
includedKbNumbers:
{
Description: KB numbers included from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
rebootSetting:
{
Description: Reboot setting for the software update configuration. ,
Required: False ,
}
string ,
}
,
linux:
{
Description: Linux specific update configuration. ,
Required: False ,
}
{
includedPackageClassifications:
{
Description: Update classifications included in the software update configuration. ,
Enum:
{
Unclassified: No description available. ,
Critical: No description available. ,
Security: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
excludedPackageNameMasks:
{
Description: packages excluded from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
includedPackageNameMasks:
{
Description: packages included from the software update configuration. ,
Required: False ,
}
[
string ,
]
,
rebootSetting:
{
Description: Reboot setting for the software update configuration. ,
Required: False ,
}
string ,
}
,
duration:
{
Description: Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601 ,
Format: duration ,
Required: False ,
}
string ,
azureVirtualMachines:
{
Description: List of azure resource Ids for azure virtual machines targeted by the software update configuration. ,
Required: False ,
}
[
string ,
]
,
nonAzureComputerNames:
{
Description: List of names of non-azure machines targeted by the software update configuration. ,
Required: False ,
}
[
string ,
]
,
targets:
{
Description: Group targets for the software update configuration. ,
Required: False ,
}
{
azureQueries:
{
Description: List of Azure queries in the software update configuration. ,
Required: False ,
}
[
{
scope:
{
Description: List of Subscription or Resource Group ARM Ids. ,
Required: False ,
}
[
string ,
]
,
locations:
{
Description: List of locations to scope the query to. ,
Required: False ,
}
[
string ,
]
,
tagSettings:
{
Description: Tag settings for the VM. ,
Required: False ,
}
{
tags:
{
Description: Dictionary of tags with its list of values. ,
Required: False ,
}
object ,
filterOperator:
{
Description: Filter VMs by Any or All specified tags. ,
Enum:
{
All: No description available. ,
Any: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nonAzureQueries:
{
Description: List of non Azure queries in the software update configuration. ,
Required: False ,
}
[
{
functionAlias:
{
Description: Log Analytics Saved Search name. ,
Required: False ,
}
string ,
workspaceId:
{
Description: Workspace Id for Log Analytics in which the saved Search is resided. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
tasks:
{
Description: Pre and Post Tasks defined ,
Required: False ,
}
{
preTask:
{
Description: Pre task properties. ,
Required: False ,
}
{
parameters:
{
Description: Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
postTask:
{
Description: Post task properties. ,
Required: False ,
}
{
parameters:
{
Description: Gets or sets the parameters of the task. ,
Required: False ,
}
object ,
source:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
}
,
frequency:
{
Description: execution frequency of the schedule associated with the software update configuration ,
Enum:
{
OneTime: No description available. ,
Day: No description available. ,
Hour: No description available. ,
Week: No description available. ,
Month: No description available. ,
Minute: The minimum allowed interval for Minute schedules is 15 minutes. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: the start time of the update. ,
Format: date-time ,
Required: False ,
}
string ,
creationTime:
{
Description: Creation time of the software update configuration, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last time software update configuration was modified, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state for the software update configuration, which only appears in the response. ,
Required: False ,
}
string ,
nextRun:
{
Description: ext run time of the update. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SoftwareUpdateConfigurationMachineRuns_GetById (new)
Description :  Get a single software update configuration machine run by Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationMachineRuns/{softwareUpdateConfigurationMachineRunId}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
softwareUpdateConfigurationMachineRunId:
{
Description: The Id of the software update configuration machine run. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the software update configuration machine run ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the software update configuration machine run ,
Required: False ,
}
string ,
properties:
{
Description: Software update configuration machine run properties. ,
Required: False ,
}
{
targetComputer:
{
Description: name of the updated computer ,
Required: False ,
}
string ,
targetComputerType:
{
Description: type of the updated computer. ,
Required: False ,
}
string ,
softwareUpdateConfiguration:
{
Description: software update configuration triggered this run ,
Required: False ,
}
{
name:
{
Description: Name of the software update configuration triggered the software update configuration run ,
Required: False ,
}
string ,
}
,
status:
{
Description: Status of the software update configuration machine run. ,
Required: False ,
}
string ,
osType:
{
Description: Operating system target of the software update configuration triggered this run ,
Required: False ,
}
string ,
correlationId:
{
Description: correlation id of the software update configuration machine run ,
Format: uuid ,
Required: False ,
}
string ,
sourceComputerId:
{
Description: source computer id of the software update configuration machine run ,
Format: uuid ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the software update configuration machine run. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the software update configuration machine run. ,
Format: date-time ,
Required: False ,
}
string ,
configuredDuration:
{
Description: configured duration for the software update configuration run. ,
Required: False ,
}
string ,
job:
{
Description: Job associated with the software update configuration machine run ,
Required: False ,
}
{
id:
{
Description: Id of the job associated with the software update configuration run ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Creation time of the resource, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: createdBy property, which only appears in the response. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last time resource was modified, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: lastModifiedBy property, which only appears in the response. ,
Required: False ,
}
string ,
error:
{
Description: Details of provisioning error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SoftwareUpdateConfigurationMachineRuns_List (new)
Description :  Return list of software update configuration machine runs
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationMachineRuns
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. You can use the following filters: 'properties/osType', 'properties/status', 'properties/startTime', and 'properties/softwareUpdateConfiguration/name' ,
Required: False ,
}
string ,
$skip:
{
Description: number of entries you skip before returning results ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of entries returned in the results collection ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: outer object returned when listing all software update configuration machine runs ,
Required: False ,
}
[
{
name:
{
Description: Name of the software update configuration machine run ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the software update configuration machine run ,
Required: False ,
}
string ,
properties:
{
Description: Software update configuration machine run properties. ,
Required: False ,
}
{
targetComputer:
{
Description: name of the updated computer ,
Required: False ,
}
string ,
targetComputerType:
{
Description: type of the updated computer. ,
Required: False ,
}
string ,
softwareUpdateConfiguration:
{
Description: software update configuration triggered this run ,
Required: False ,
}
{
name:
{
Description: Name of the software update configuration triggered the software update configuration run ,
Required: False ,
}
string ,
}
,
status:
{
Description: Status of the software update configuration machine run. ,
Required: False ,
}
string ,
osType:
{
Description: Operating system target of the software update configuration triggered this run ,
Required: False ,
}
string ,
correlationId:
{
Description: correlation id of the software update configuration machine run ,
Format: uuid ,
Required: False ,
}
string ,
sourceComputerId:
{
Description: source computer id of the software update configuration machine run ,
Format: uuid ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the software update configuration machine run. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the software update configuration machine run. ,
Format: date-time ,
Required: False ,
}
string ,
configuredDuration:
{
Description: configured duration for the software update configuration run. ,
Required: False ,
}
string ,
job:
{
Description: Job associated with the software update configuration machine run ,
Required: False ,
}
{
id:
{
Description: Id of the job associated with the software update configuration run ,
Required: False ,
}
string ,
}
,
creationTime:
{
Description: Creation time of the resource, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: createdBy property, which only appears in the response. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last time resource was modified, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: lastModifiedBy property, which only appears in the response. ,
Required: False ,
}
string ,
error:
{
Description: Details of provisioning error ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: link to next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SoftwareUpdateConfigurationRuns_GetById (new)
Description :  Get a single software update configuration Run by Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns/{softwareUpdateConfigurationRunId}
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
softwareUpdateConfigurationRunId:
{
Description: The Id of the software update configuration run. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the software update configuration run. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the software update configuration run ,
Required: False ,
}
string ,
properties:
{
Description: Software update configuration Run properties. ,
Required: False ,
}
{
softwareUpdateConfiguration:
{
Description: software update configuration triggered this run ,
Required: False ,
}
{
name:
{
Description: Name of the software update configuration triggered the software update configuration run ,
Required: False ,
}
string ,
}
,
status:
{
Description: Status of the software update configuration run. ,
Required: False ,
}
string ,
configuredDuration:
{
Description: Configured duration for the software update configuration run. ,
Required: False ,
}
string ,
osType:
{
Description: Operating system target of the software update configuration triggered this run ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the software update configuration run. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the software update configuration run. ,
Format: date-time ,
Required: False ,
}
string ,
computerCount:
{
Description: Number of computers in the software update configuration run. ,
Required: False ,
}
integer ,
failedCount:
{
Description: Number of computers with failed status. ,
Required: False ,
}
integer ,
creationTime:
{
Description: Creation time of the resource, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: CreatedBy property, which only appears in the response. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last time resource was modified, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: LastModifiedBy property, which only appears in the response. ,
Required: False ,
}
string ,
tasks:
{
Description: Software update configuration tasks triggered in this run ,
Required: False ,
}
{
preTask:
{
Description: Pre task properties. ,
Required: False ,
}
{
status:
{
Description: The status of the task. ,
Required: False ,
}
string ,
source:
{
Description: The name of the source of the task. ,
Required: False ,
}
string ,
jobId:
{
Description: The job id of the task. ,
Required: False ,
}
string ,
}
,
postTask:
{
Description: Post task properties. ,
Required: False ,
}
{
status:
{
Description: The status of the task. ,
Required: False ,
}
string ,
source:
{
Description: The name of the source of the task. ,
Required: False ,
}
string ,
jobId:
{
Description: The job id of the task. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SoftwareUpdateConfigurationRuns_List (new)
Description :  Return list of software update configuration runs
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns
{
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
clientRequestId:
{
Description: Identifies this specific client request. ,
Required: False ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. You can use the following filters: 'properties/osType', 'properties/status', 'properties/startTime', and 'properties/softwareUpdateConfiguration/name' ,
Required: False ,
}
string ,
$skip:
{
Description: Number of entries you skip before returning results ,
Required: False ,
}
string ,
$top:
{
Description: Maximum number of entries returned in the results collection ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: outer object returned when listing all software update configuration runs ,
Required: False ,
}
[
{
name:
{
Description: Name of the software update configuration run. ,
Required: False ,
}
string ,
id:
{
Description: Resource Id of the software update configuration run ,
Required: False ,
}
string ,
properties:
{
Description: Software update configuration Run properties. ,
Required: False ,
}
{
softwareUpdateConfiguration:
{
Description: software update configuration triggered this run ,
Required: False ,
}
{
name:
{
Description: Name of the software update configuration triggered the software update configuration run ,
Required: False ,
}
string ,
}
,
status:
{
Description: Status of the software update configuration run. ,
Required: False ,
}
string ,
configuredDuration:
{
Description: Configured duration for the software update configuration run. ,
Required: False ,
}
string ,
osType:
{
Description: Operating system target of the software update configuration triggered this run ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the software update configuration run. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: End time of the software update configuration run. ,
Format: date-time ,
Required: False ,
}
string ,
computerCount:
{
Description: Number of computers in the software update configuration run. ,
Required: False ,
}
integer ,
failedCount:
{
Description: Number of computers with failed status. ,
Required: False ,
}
integer ,
creationTime:
{
Description: Creation time of the resource, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: CreatedBy property, which only appears in the response. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Last time resource was modified, which only appears in the response. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: LastModifiedBy property, which only appears in the response. ,
Required: False ,
}
string ,
tasks:
{
Description: Software update configuration tasks triggered in this run ,
Required: False ,
}
{
preTask:
{
Description: Pre task properties. ,
Required: False ,
}
{
status:
{
Description: The status of the task. ,
Required: False ,
}
string ,
source:
{
Description: The name of the source of the task. ,
Required: False ,
}
string ,
jobId:
{
Description: The job id of the task. ,
Required: False ,
}
string ,
}
,
postTask:
{
Description: Post task properties. ,
Required: False ,
}
{
status:
{
Description: The status of the task. ,
Required: False ,
}
string ,
source:
{
Description: The name of the source of the task. ,
Required: False ,
}
string ,
jobId:
{
Description: The job id of the task. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: link to next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SourceControl_CreateOrUpdate (new)
Description :  Create a source control.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
sourceControlName:
{
Description: The source control name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the create or update source control operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the source control. ,
Required: True ,
}
{
repoUrl:
{
Description: The repo url of the source control. ,
Required: False ,
}
string ,
branch:
{
Description: The repo branch of the source control. Include branch as empty string for VsoTfvc. ,
Required: False ,
}
string ,
folderPath:
{
Description: The folder path of the source control. Path must be relative. ,
Required: False ,
}
string ,
autoSync:
{
Description: The auto async of the source control. Default is false. ,
Required: False ,
}
boolean ,
publishRunbook:
{
Description: The auto publish of the source control. Default is true. ,
Required: False ,
}
boolean ,
sourceType:
{
Description: The source type. Must be one of VsoGit, VsoTfvc, GitHub, case sensitive. ,
Enum:
{
VsoGit: No description available. ,
VsoTfvc: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
securityToken:
{
Description: The authorization token for the repo of the source control. ,
Required: False ,
}
{
accessToken:
{
Description: The access token. ,
Required: False ,
}
string ,
refreshToken:
{
Description: The refresh token. ,
Required: False ,
}
string ,
tokenType:
{
Description: The token type. Must be either PersonalAccessToken or Oauth. ,
Enum:
{
PersonalAccessToken: No description available. ,
Oauth: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: The user description of the source control. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the source control. ,
Required: False ,
}
{
repoUrl:
{
Description: The repo url of the source control. ,
Required: False ,
}
string ,
branch:
{
Description: The repo branch of the source control. Include branch as empty string for VsoTfvc. ,
Required: False ,
}
string ,
folderPath:
{
Description: The folder path of the source control. ,
Required: False ,
}
string ,
autoSync:
{
Description: The auto sync of the source control. Default is false. ,
Required: False ,
}
boolean ,
publishRunbook:
{
Description: The auto publish of the source control. Default is true. ,
Required: False ,
}
boolean ,
sourceType:
{
Description: The source type. Must be one of VsoGit, VsoTfvc, GitHub. ,
Enum:
{
VsoGit: No description available. ,
VsoTfvc: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the source control. ,
Required: False ,
}
{
repoUrl:
{
Description: The repo url of the source control. ,
Required: False ,
}
string ,
branch:
{
Description: The repo branch of the source control. Include branch as empty string for VsoTfvc. ,
Required: False ,
}
string ,
folderPath:
{
Description: The folder path of the source control. ,
Required: False ,
}
string ,
autoSync:
{
Description: The auto sync of the source control. Default is false. ,
Required: False ,
}
boolean ,
publishRunbook:
{
Description: The auto publish of the source control. Default is true. ,
Required: False ,
}
boolean ,
sourceType:
{
Description: The source type. Must be one of VsoGit, VsoTfvc, GitHub. ,
Enum:
{
VsoGit: No description available. ,
VsoTfvc: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SourceControl_Update (new)
Description :  Update a source control.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
sourceControlName:
{
Description: The source control name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the update source control operation. ,
Required: True ,
}
{
properties:
{
Description: The value of the source control. ,
Required: False ,
}
{
branch:
{
Description: The repo branch of the source control. ,
Required: False ,
}
string ,
folderPath:
{
Description: The folder path of the source control. Path must be relative. ,
Required: False ,
}
string ,
autoSync:
{
Description: The auto sync of the source control. Default is false. ,
Required: False ,
}
boolean ,
publishRunbook:
{
Description: The auto publish of the source control. Default is true. ,
Required: False ,
}
boolean ,
securityToken:
{
Description: The authorization token for the repo of the source control. ,
Required: False ,
}
{
accessToken:
{
Description: The access token. ,
Required: False ,
}
string ,
refreshToken:
{
Description: The refresh token. ,
Required: False ,
}
string ,
tokenType:
{
Description: The token type. Must be either PersonalAccessToken or Oauth. ,
Enum:
{
PersonalAccessToken: No description available. ,
Oauth: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
description:
{
Description: The user description of the source control. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the source control. ,
Required: False ,
}
{
repoUrl:
{
Description: The repo url of the source control. ,
Required: False ,
}
string ,
branch:
{
Description: The repo branch of the source control. Include branch as empty string for VsoTfvc. ,
Required: False ,
}
string ,
folderPath:
{
Description: The folder path of the source control. ,
Required: False ,
}
string ,
autoSync:
{
Description: The auto sync of the source control. Default is false. ,
Required: False ,
}
boolean ,
publishRunbook:
{
Description: The auto publish of the source control. Default is true. ,
Required: False ,
}
boolean ,
sourceType:
{
Description: The source type. Must be one of VsoGit, VsoTfvc, GitHub. ,
Enum:
{
VsoGit: No description available. ,
VsoTfvc: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SourceControl_Delete (new)
Description :  Delete the source control.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
sourceControlName:
{
Description: The name of source control. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SourceControl_Get (new)
Description :  Retrieve the source control identified by source control name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
sourceControlName:
{
Description: The name of source control. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the source control. ,
Required: False ,
}
{
repoUrl:
{
Description: The repo url of the source control. ,
Required: False ,
}
string ,
branch:
{
Description: The repo branch of the source control. Include branch as empty string for VsoTfvc. ,
Required: False ,
}
string ,
folderPath:
{
Description: The folder path of the source control. ,
Required: False ,
}
string ,
autoSync:
{
Description: The auto sync of the source control. Default is false. ,
Required: False ,
}
boolean ,
publishRunbook:
{
Description: The auto publish of the source control. Default is true. ,
Required: False ,
}
boolean ,
sourceType:
{
Description: The source type. Must be one of VsoGit, VsoTfvc, GitHub. ,
Enum:
{
VsoGit: No description available. ,
VsoTfvc: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SourceControl_ListByAutomationAccount (new)
Description :  Retrieve a list of source controls.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of source controls. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the source control. ,
Required: False ,
}
{
repoUrl:
{
Description: The repo url of the source control. ,
Required: False ,
}
string ,
branch:
{
Description: The repo branch of the source control. Include branch as empty string for VsoTfvc. ,
Required: False ,
}
string ,
folderPath:
{
Description: The folder path of the source control. ,
Required: False ,
}
string ,
autoSync:
{
Description: The auto sync of the source control. Default is false. ,
Required: False ,
}
boolean ,
publishRunbook:
{
Description: The auto publish of the source control. Default is true. ,
Required: False ,
}
boolean ,
sourceType:
{
Description: The source type. Must be one of VsoGit, VsoTfvc, GitHub. ,
Enum:
{
VsoGit: No description available. ,
VsoTfvc: No description available. ,
GitHub: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SourceControlSyncJob_Create (new)
Description :  Creates the sync job for a source control.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs/{sourceControlSyncJobId}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
sourceControlName:
{
Description: The source control name. ,
Required: True ,
}
string ,
sourceControlSyncJobId:
{
Description: The source control sync job id. ,
Format: uuid ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the create source control sync job operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the source control sync job. ,
Required: True ,
}
{
commitId:
{
Description: The commit id of the source control sync job. If not syncing to a commitId, enter an empty string. ,
Required: True ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
id:
{
Description: Resource id. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the source control sync job. ,
Required: False ,
}
{
sourceControlSyncJobId:
{
Description: The source control sync job id. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the job. ,
Enum:
{
Completed: No description available. ,
Failed: No description available. ,
Running: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
syncType:
{
Description: The sync type. ,
Enum:
{
PartialSync: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SourceControlSyncJob_Get (new)
Description :  Retrieve the source control sync job identified by job id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs/{sourceControlSyncJobId}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
sourceControlName:
{
Description: The source control name. ,
Required: True ,
}
string ,
sourceControlSyncJobId:
{
Description: The source control sync job id. ,
Format: uuid ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the job. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the source control sync job. ,
Required: False ,
}
{
sourceControlSyncJobId:
{
Description: The source control sync job id. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the job. ,
Enum:
{
Completed: No description available. ,
Failed: No description available. ,
Running: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
syncType:
{
Description: The sync type. ,
Enum:
{
PartialSync: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
exception:
{
Description: The exceptions that occurred while running the sync job. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SourceControlSyncJob_ListByAutomationAccount (new)
Description :  Retrieve a list of source control sync jobs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
sourceControlName:
{
Description: The source control name. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of source control sync jobs. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
id:
{
Description: Resource id. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the source control sync job. ,
Required: False ,
}
{
sourceControlSyncJobId:
{
Description: The source control sync job id. ,
Required: False ,
}
string ,
creationTime:
{
Description: The creation time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the job. ,
Enum:
{
Completed: No description available. ,
Failed: No description available. ,
Running: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: The start time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
syncType:
{
Description: The sync type. ,
Enum:
{
PartialSync: No description available. ,
FullSync: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SourceControlSyncJobStreams_ListBySyncJob (new)
Description :  Retrieve a list of sync job streams identified by sync job id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs/{sourceControlSyncJobId}/streams
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
sourceControlName:
{
Description: The source control name. ,
Required: True ,
}
string ,
sourceControlSyncJobId:
{
Description: The source control sync job id. ,
Format: uuid ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of source control sync job streams. ,
Required: False ,
}
[
{
id:
{
Description: Resource id. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the source control sync job stream. ,
Required: False ,
}
{
sourceControlSyncJobStreamId:
{
Description: The sync job stream id. ,
Required: False ,
}
string ,
summary:
{
Description: The summary of the sync job stream. ,
Required: False ,
}
string ,
time:
{
Description: The time of the sync job stream. ,
Format: date-time ,
Required: False ,
}
string ,
streamType:
{
Description: The type of the sync job stream. ,
Enum:
{
Error: No description available. ,
Output: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
SourceControlSyncJobStreams_Get (new)
Description :  Retrieve a sync job stream identified by stream id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs/{sourceControlSyncJobId}/streams/{streamId}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
sourceControlName:
{
Description: The source control name. ,
Required: True ,
}
string ,
sourceControlSyncJobId:
{
Description: The source control sync job id. ,
Format: uuid ,
Required: True ,
}
string ,
streamId:
{
Description: The id of the sync job stream. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource id. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the source control sync job stream. ,
Required: False ,
}
{
sourceControlSyncJobStreamId:
{
Description: The sync job stream id. ,
Required: False ,
}
string ,
summary:
{
Description: The summary of the sync job stream. ,
Required: False ,
}
string ,
time:
{
Description: The time of the sync job stream. ,
Format: date-time ,
Required: False ,
}
string ,
streamType:
{
Description: The type of the sync job stream. ,
Enum:
{
Error: No description available. ,
Output: No description available. ,
}
,
Required: False ,
}
enum ,
streamText:
{
Description: The text of the sync job stream. ,
Required: False ,
}
string ,
value:
{
Description: The values of the job stream. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Variable_CreateOrUpdate (new)
Description :  Create a variable.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/variables/{variableName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
variableName:
{
Description: The variable name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the create or update variable operation. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the variable. ,
Required: True ,
}
string ,
properties:
{
Description: Gets or sets the properties of the variable. ,
Required: True ,
}
{
value:
{
Description: Gets or sets the value of the variable. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description of the variable. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Gets or sets the encrypted flag of the variable. ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties of the variable. ,
Required: False ,
}
{
value:
{
Description: Gets or sets the value of the variable. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Gets or sets the encrypted flag of the variable. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the properties of the variable. ,
Required: False ,
}
{
value:
{
Description: Gets or sets the value of the variable. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Gets or sets the encrypted flag of the variable. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Variable_Update (new)
Description :  Update a variable.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/variables/{variableName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
variableName:
{
Description: The variable name. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters supplied to the update variable operation. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the variable. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the value of the variable. ,
Required: False ,
}
{
value:
{
Description: Gets or sets the value of the variable. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description of the variable. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties of the variable. ,
Required: False ,
}
{
value:
{
Description: Gets or sets the value of the variable. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Gets or sets the encrypted flag of the variable. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Variable_Delete (new)
Description :  Delete the variable.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/variables/{variableName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
variableName:
{
Description: The name of variable. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Variable_Get (new)
Description :  Retrieve the variable identified by variable name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/variables/{variableName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
variableName:
{
Description: The name of variable. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the properties of the variable. ,
Required: False ,
}
{
value:
{
Description: Gets or sets the value of the variable. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Gets or sets the encrypted flag of the variable. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Variable_ListByAutomationAccount (new)
Description :  Retrieve a list of variables.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/variables
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of variables. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the properties of the variable. ,
Required: False ,
}
{
value:
{
Description: Gets or sets the value of the variable. ,
Required: False ,
}
string ,
isEncrypted:
{
Description: Gets or sets the encrypted flag of the variable. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Watcher_CreateOrUpdate (new)
Description :  Create the watcher identified by watcher name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
watcherName:
{
Description: The watcher name. ,
Required: True ,
}
string ,
parameters:
{
Description: The create or update parameters for watcher. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the watcher properties. ,
Required: False ,
}
{
executionFrequencyInSeconds:
{
Description: Gets or sets the frequency at which the watcher is invoked. ,
Format: int64 ,
Required: False ,
}
integer ,
scriptName:
{
Description: Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook. ,
Required: False ,
}
string ,
scriptParameters:
{
Description: Gets or sets the parameters of the script. ,
Required: False ,
}
object ,
scriptRunOn:
{
Description: Gets or sets the name of the hybrid worker group the watcher will run on. ,
Required: False ,
}
string ,
status:
{
Description: Gets the current status of the watcher. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Details of the user who last modified the watcher. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the watcher properties. ,
Required: False ,
}
{
executionFrequencyInSeconds:
{
Description: Gets or sets the frequency at which the watcher is invoked. ,
Format: int64 ,
Required: False ,
}
integer ,
scriptName:
{
Description: Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook. ,
Required: False ,
}
string ,
scriptParameters:
{
Description: Gets or sets the parameters of the script. ,
Required: False ,
}
object ,
scriptRunOn:
{
Description: Gets or sets the name of the hybrid worker group the watcher will run on. ,
Required: False ,
}
string ,
status:
{
Description: Gets the current status of the watcher. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Details of the user who last modified the watcher. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the watcher properties. ,
Required: False ,
}
{
executionFrequencyInSeconds:
{
Description: Gets or sets the frequency at which the watcher is invoked. ,
Format: int64 ,
Required: False ,
}
integer ,
scriptName:
{
Description: Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook. ,
Required: False ,
}
string ,
scriptParameters:
{
Description: Gets or sets the parameters of the script. ,
Required: False ,
}
object ,
scriptRunOn:
{
Description: Gets or sets the name of the hybrid worker group the watcher will run on. ,
Required: False ,
}
string ,
status:
{
Description: Gets the current status of the watcher. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Details of the user who last modified the watcher. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Watcher_Get (new)
Description :  Retrieve the watcher identified by watcher name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
watcherName:
{
Description: The watcher name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the watcher properties. ,
Required: False ,
}
{
executionFrequencyInSeconds:
{
Description: Gets or sets the frequency at which the watcher is invoked. ,
Format: int64 ,
Required: False ,
}
integer ,
scriptName:
{
Description: Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook. ,
Required: False ,
}
string ,
scriptParameters:
{
Description: Gets or sets the parameters of the script. ,
Required: False ,
}
object ,
scriptRunOn:
{
Description: Gets or sets the name of the hybrid worker group the watcher will run on. ,
Required: False ,
}
string ,
status:
{
Description: Gets the current status of the watcher. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Details of the user who last modified the watcher. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Watcher_Update (new)
Description :  Update the watcher identified by watcher name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
watcherName:
{
Description: The watcher name. ,
Required: True ,
}
string ,
parameters:
{
Description: The update parameters for watcher. ,
Required: True ,
}
{
properties:
{
Description: Gets or sets the watcher update properties. ,
Required: False ,
}
{
executionFrequencyInSeconds:
{
Description: Gets or sets the frequency at which the watcher is invoked. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
name:
{
Description: Gets or sets the name of the resource. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the watcher properties. ,
Required: False ,
}
{
executionFrequencyInSeconds:
{
Description: Gets or sets the frequency at which the watcher is invoked. ,
Format: int64 ,
Required: False ,
}
integer ,
scriptName:
{
Description: Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook. ,
Required: False ,
}
string ,
scriptParameters:
{
Description: Gets or sets the parameters of the script. ,
Required: False ,
}
object ,
scriptRunOn:
{
Description: Gets or sets the name of the hybrid worker group the watcher will run on. ,
Required: False ,
}
string ,
status:
{
Description: Gets the current status of the watcher. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Details of the user who last modified the watcher. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Watcher_Delete (new)
Description :  Delete the watcher by name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
watcherName:
{
Description: The watcher name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Watcher_Start (new)
Description :  Resume the watcher identified by watcher name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}/start
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
watcherName:
{
Description: The watcher name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Watcher_Stop (new)
Description :  Resume the watcher identified by watcher name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}/stop
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
watcherName:
{
Description: The watcher name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Watcher_ListByAutomationAccount (new)
Description :  Retrieve a list of watchers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of watchers. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the watcher properties. ,
Required: False ,
}
{
executionFrequencyInSeconds:
{
Description: Gets or sets the frequency at which the watcher is invoked. ,
Format: int64 ,
Required: False ,
}
integer ,
scriptName:
{
Description: Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook. ,
Required: False ,
}
string ,
scriptParameters:
{
Description: Gets or sets the parameters of the script. ,
Required: False ,
}
object ,
scriptRunOn:
{
Description: Gets or sets the name of the hybrid worker group the watcher will run on. ,
Required: False ,
}
string ,
status:
{
Description: Gets the current status of the watcher. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Details of the user who last modified the watcher. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
etag:
{
Description: Gets or sets the etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Webhook_GenerateUri (new)
Description :  Generates a Uri for use in creating a webhook.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/generateUri
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Webhook_Delete (new)
Description :  Delete the webhook by name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
webhookName:
{
Description: The webhook name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Webhook_Get (new)
Description :  Retrieve the webhook identified by webhook name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
webhookName:
{
Description: The webhook name. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the webhook properties. ,
Required: False ,
}
{
isEnabled:
{
Description: Gets or sets the value of the enabled flag of the webhook. ,
Required: False ,
}
boolean ,
uri:
{
Description: Gets or sets the webhook uri. ,
Required: False ,
}
string ,
expiryTime:
{
Description: Gets or sets the expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
lastInvokedTime:
{
Description: Gets or sets the last invoked time. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with. ,
Required: False ,
}
object ,
runbook:
{
Description: Gets or sets the runbook the webhook is associated with. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
runOn:
{
Description: Gets or sets the name of the hybrid worker group the webhook job will run on. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Details of the user who last modified the Webhook ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Webhook_CreateOrUpdate (new)
Description :  Create the webhook identified by webhook name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
webhookName:
{
Description: The webhook name. ,
Required: True ,
}
string ,
parameters:
{
Description: The create or update parameters for webhook. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the webhook. ,
Required: True ,
}
string ,
properties:
{
Description: Gets or sets the properties of the webhook. ,
Required: True ,
}
{
isEnabled:
{
Description: Gets or sets the value of the enabled flag of webhook. ,
Required: False ,
}
boolean ,
uri:
{
Description: Gets or sets the uri. ,
Required: False ,
}
string ,
expiryTime:
{
Description: Gets or sets the expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the job. ,
Required: False ,
}
object ,
runbook:
{
Description: Gets or sets the runbook. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
runOn:
{
Description: Gets or sets the name of the hybrid worker group the webhook job will run on. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the webhook properties. ,
Required: False ,
}
{
isEnabled:
{
Description: Gets or sets the value of the enabled flag of the webhook. ,
Required: False ,
}
boolean ,
uri:
{
Description: Gets or sets the webhook uri. ,
Required: False ,
}
string ,
expiryTime:
{
Description: Gets or sets the expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
lastInvokedTime:
{
Description: Gets or sets the last invoked time. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with. ,
Required: False ,
}
object ,
runbook:
{
Description: Gets or sets the runbook the webhook is associated with. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
runOn:
{
Description: Gets or sets the name of the hybrid worker group the webhook job will run on. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Details of the user who last modified the Webhook ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Gets or sets the webhook properties. ,
Required: False ,
}
{
isEnabled:
{
Description: Gets or sets the value of the enabled flag of the webhook. ,
Required: False ,
}
boolean ,
uri:
{
Description: Gets or sets the webhook uri. ,
Required: False ,
}
string ,
expiryTime:
{
Description: Gets or sets the expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
lastInvokedTime:
{
Description: Gets or sets the last invoked time. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with. ,
Required: False ,
}
object ,
runbook:
{
Description: Gets or sets the runbook the webhook is associated with. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
runOn:
{
Description: Gets or sets the name of the hybrid worker group the webhook job will run on. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Details of the user who last modified the Webhook ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Webhook_Update (new)
Description :  Update the webhook identified by webhook name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName}
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
webhookName:
{
Description: The webhook name. ,
Required: True ,
}
string ,
parameters:
{
Description: The update parameters for webhook. ,
Required: True ,
}
{
name:
{
Description: Gets or sets the name of the webhook. ,
Required: False ,
}
string ,
properties:
{
Description: Gets or sets the value of the webhook. ,
Required: False ,
}
{
isEnabled:
{
Description: Gets or sets the value of the enabled flag of webhook. ,
Required: False ,
}
boolean ,
runOn:
{
Description: Gets or sets the name of the hybrid worker group the webhook job will run on. ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the job. ,
Required: False ,
}
object ,
description:
{
Description: Gets or sets the description of the webhook. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets or sets the webhook properties. ,
Required: False ,
}
{
isEnabled:
{
Description: Gets or sets the value of the enabled flag of the webhook. ,
Required: False ,
}
boolean ,
uri:
{
Description: Gets or sets the webhook uri. ,
Required: False ,
}
string ,
expiryTime:
{
Description: Gets or sets the expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
lastInvokedTime:
{
Description: Gets or sets the last invoked time. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with. ,
Required: False ,
}
object ,
runbook:
{
Description: Gets or sets the runbook the webhook is associated with. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
runOn:
{
Description: Gets or sets the name of the hybrid worker group the webhook job will run on. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Details of the user who last modified the Webhook ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Webhook_ListByAutomationAccount (new)
Description :  Retrieve a list of webhooks.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks
{
resourceGroupName:
{
Description: Name of an Azure Resource group. ,
Required: True ,
}
string ,
automationAccountName:
{
Description: The name of the automation account. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets a list of webhooks. ,
Required: False ,
}
[
{
properties:
{
Description: Gets or sets the webhook properties. ,
Required: False ,
}
{
isEnabled:
{
Description: Gets or sets the value of the enabled flag of the webhook. ,
Required: False ,
}
boolean ,
uri:
{
Description: Gets or sets the webhook uri. ,
Required: False ,
}
string ,
expiryTime:
{
Description: Gets or sets the expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
lastInvokedTime:
{
Description: Gets or sets the last invoked time. ,
Format: date-time ,
Required: False ,
}
string ,
parameters:
{
Description: Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with. ,
Required: False ,
}
object ,
runbook:
{
Description: Gets or sets the runbook the webhook is associated with. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the name of the runbook. ,
Required: False ,
}
string ,
}
,
runOn:
{
Description: Gets or sets the name of the hybrid worker group the webhook job will run on. ,
Required: False ,
}
string ,
creationTime:
{
Description: Gets or sets the creation time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets or sets the last modified time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Details of the user who last modified the Webhook ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets or sets the next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}