Package - Create Or Update

Service:: Automation

API Version:: 2023-05-15-preview

Create or update the package identified by package name.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runtimeEnvironments/{runtimeEnvironmentName}/packages/{packageName}?api-version=2023-05-15-preview

URI Parameters

Name	In	Required	Type	Description
automationAccountName	path	True	string	The name of the automation account.
packageName	path	True	string	The name of Package.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
runtimeEnvironmentName	path	True	string pattern: ^[a-zA-Z][a-zA-Z-_0-9]*$	The name of the Runtime Environment.
subscriptionId	path	True	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Request Body

Name	Required	Type	Description
properties.contentLink	True	ContentLink	Gets or sets the package content link.
allOf		TrackedResource	Tracked Resource The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Responses

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

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create or update a package

Sample request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/runtimeEnvironmentName/packages/OmsCompositeResources?api-version=2023-05-15-preview

{
  "properties": {
    "contentLink": {
      "uri": "https://teststorage.blob.core.windows.net/dsccomposite/OmsCompositeResources.zip",
      "contentHash": {
        "algorithm": "sha265",
        "value": "07E108A962B81DD9C9BAA89BB47C0F6EE52B29E83758B07795E408D258B2B87A"
      }
    }
  }
}

Sample response

Status code:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/runtimeEnvironmentName/packages/OmsCompositeResources",
  "name": "OmsCompositeResources",
  "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments/packages",
  "location": "East US 2",
  "tags": {},
  "properties": {
    "default": false,
    "version": null,
    "sizeInBytes": 0,
    "error": {
      "code": null,
      "message": null
    },
    "provisioningState": "Creating"
  },
  "systemData": {
    "createdAt": "2023-07-05T07:32:41.4389914+00:00",
    "lastModifiedAt": "2023-07-05T07:33:07.5597465+00:00"
  }
}

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/runtimeEnvironments/runtimeEnvironmentName/packages/OmsCompositeResources",
  "name": "OmsCompositeResources",
  "type": "Microsoft.Automation/automationAccounts/runtimeEnvironments/packages",
  "location": "East US 2",
  "tags": {},
  "properties": {
    "default": false,
    "version": null,
    "sizeInBytes": 0,
    "error": {
      "code": null,
      "message": null
    },
    "provisioningState": "Creating"
  },
  "systemData": {
    "createdAt": "2023-07-05T07:32:41.4389914+00:00",
    "lastModifiedAt": "2023-07-05T07:33:07.5597465+00:00"
  }
}

Definitions

Name	Description
ContentHash	Definition of the runbook property type.
ContentLink	Definition of the content link.
createdByType	The type of identity that created the resource.
ErrorResponse	Error response of an operation failure
Package	Definition of the Package type.
PackageCreateOrUpdateParameters	The parameters supplied to the create or update package operation.
PackageErrorInfo	Definition of the package error info type.
PackageProvisioningState	Gets or sets the provisioning state of the Package.
systemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	Tracked Resource

ContentHash

Object

Definition of the runbook property type.

Name	Type	Description
algorithm	string	Gets or sets the content hash algorithm used to hash the content.
value	string	Gets or sets expected hash value of the content.

ContentLink

Object

Definition of the content link.

Name	Type	Description
contentHash	ContentHash	Gets or sets the hash.
uri	string	Gets or sets the uri of content.
version	string	Gets or sets the version of the content.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Error response of an operation failure

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

Package

Object

Definition of the Package type.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.allOf	systemData	Metadata pertaining to creation and last modification of the resource.
properties.contentLink	ContentLink	Gets or sets the contentLink of the Package.
properties.default	boolean	Gets or sets the isGlobal flag of the package.
properties.error	PackageErrorInfo	Gets or sets the error info of the Package.
properties.provisioningState	PackageProvisioningState	Gets or sets the provisioning state of the Package.
properties.sizeInBytes	integer (int64)	Gets or sets the size in bytes of the Package.
properties.version	string	Gets or sets the version of the Package.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PackageCreateOrUpdateParameters

Object

The parameters supplied to the create or update package operation.

Name	Type	Description
allOf	TrackedResource	Tracked Resource The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
properties.contentLink	ContentLink	Gets or sets the package content link.

PackageErrorInfo

Object

Definition of the package error info type.

Name	Type	Description
code	string	Package import error code.
message	string	Package import error message.

PackageProvisioningState

Enumeration

Gets or sets the provisioning state of the Package.

Value	Description
Created
Creating
StartingImportModuleRunbook
RunningImportModuleRunbook
ContentRetrieved
ContentDownloaded
ContentValidated
ConnectionTypeImported
ContentStored
ModuleDataStored
ActivitiesStored
ModuleImportRunbookComplete
Succeeded
Failed
Canceled
Updating

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

TrackedResource

Object

Tracked Resource

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	The geo-location where the resource lives
name	string	The name of the resource
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Share via

Package - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Create or update a package

Sample request

Sample response

Definitions

ContentHash

ContentLink

createdByType

ErrorResponse

Package

PackageCreateOrUpdateParameters

PackageErrorInfo

PackageProvisioningState

systemData

TrackedResource