Script Executions - Create Or Update

Layanan:: AVS

Versi API:: 2024-09-01

Membuat ScriptExecution

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}?api-version=2024-09-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
privateCloudName	path	True	string pattern: ^[-\w\._]+$	Nama cloud privat
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
scriptExecutionName	path	True	string pattern: ^[-\w\._]+$	Nama cmdlet skrip.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
properties.timeout	True	string	Batas waktu untuk eksekusi
properties.failureReason		string	Pesan kesalahan jika skrip dapat dijalankan, tetapi jika skrip itu sendiri memiliki kesalahan atau powershell melemparkan pengecualian
properties.hiddenParameters		ScriptExecutionParameter[]: PSCredentialExecutionParameter[] ScriptSecureStringExecutionParameter[] ScriptStringExecutionParameter[]	Parameter yang akan disembunyikan/tidak terlihat oleh ARM, seperti kata sandi dan kredensial
properties.namedOutputs		object	Kamus yang ditentukan pengguna.
properties.output		string[]	Aliran output standar dari eksekusi powershell
properties.parameters		ScriptExecutionParameter[]: PSCredentialExecutionParameter[] ScriptSecureStringExecutionParameter[] ScriptStringExecutionParameter[]	Parameter yang akan diterima skrip
properties.retention		string	Waktu hidup untuk sumber daya. Jika tidak disediakan, akan tersedia selama 60 hari
properties.scriptCmdletId		string	Referensi ke sumber daya cmdlet skrip jika pengguna menjalankan skrip AVS

Respons

Nama	Jenis	Deskripsi
200 OK	ScriptExecution	Operasi pembaruan 'ScriptExecution' sumber daya berhasil
201 Created	ScriptExecution	Operasi pembuatan 'ScriptExecution' sumber daya berhasil Header Retry-After: integer
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Nama

Jenis

Deskripsi

200 OK

ScriptExecution

Operasi pembaruan 'ScriptExecution' sumber daya berhasil

201 Created

ScriptExecution

Operasi pembuatan 'ScriptExecution' sumber daya berhasil

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ScriptExecutions_CreateOrUpdate

Permintaan sampel

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptExecutions/addSsoServer?api-version=2024-09-01

{
  "properties": {
    "scriptCmdletId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/AVS.PowerCommands@1.0.0/scriptCmdlets/New-SsoExternalIdentitySource",
    "timeout": "P0Y0M0DT0H60M60S",
    "retention": "P0Y0M60DT0H60M60S",
    "parameters": [
      {
        "name": "DomainName",
        "type": "Value",
        "value": "placeholderDomain.local"
      },
      {
        "name": "BaseUserDN",
        "type": "Value",
        "value": "DC=placeholder, DC=placeholder"
      }
    ],
    "hiddenParameters": [
      {
        "name": "Password",
        "type": "SecureValue",
        "secureValue": "PlaceholderPassword"
      }
    ]
  }
}

Respon sampel

Kode status:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptExecutions/addSsoServer",
  "name": "addSsoServer",
  "properties": {
    "scriptCmdletId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/AVS.PowerCommands@1.0.0/scriptCmdlets/New-SsoExternalIdentitySource",
    "timeout": "P0Y0M0DT0H60M60S",
    "retention": "P0Y0M60DT0H60M60S",
    "provisioningState": "Succeeded",
    "failureReason": "vCenter failed to connect to the external server",
    "parameters": [
      {
        "name": "DomainName",
        "type": "Value",
        "value": "placeholderDomain.local"
      },
      {
        "name": "BaseUserDN",
        "type": "Value",
        "value": "DC=placeholder, DC=placeholder"
      }
    ],
    "output": [
      "IdentitySource: placeholder.dc",
      "BaseDN='dc=placeholder, dc=local"
    ]
  },
  "type": "Microsoft.AVS/privateClouds/scriptExecutions"
}

Kode status:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptExecutions/addSsoServer",
  "name": "addSsoServer",
  "properties": {
    "scriptCmdletId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/AVS.PowerCommands@1.0.0/scriptCmdlets/New-SsoExternalIdentitySource",
    "timeout": "P0Y0M0DT0H60M60S",
    "retention": "P0Y0M60DT0H60M60S",
    "provisioningState": "Running",
    "parameters": [
      {
        "name": "DomainName",
        "type": "Value",
        "value": "placeholderDomain.local"
      },
      {
        "name": "BaseUserDN",
        "type": "Value",
        "value": "DC=placeholder, DC=placeholder"
      }
    ]
  },
  "type": "Microsoft.AVS/privateClouds/scriptExecutions"
}

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
PSCredentialExecutionParameter	objek kredensial powershell
ScriptExecution	Instans skrip yang dijalankan oleh pengguna - kustom atau AVS
ScriptExecutionParameterType	jenis parameter eksekusi skrip
ScriptExecutionProvisioningState	Status provisi Eksekusi Skrip
ScriptSecureStringExecutionParameter	parameter eksekusi nilai teks biasa
ScriptStringExecutionParameter	parameter eksekusi nilai teks biasa
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

PSCredentialExecutionParameter

Objek

objek kredensial powershell

Nama	Jenis	Deskripsi
name	string	Nama parameter
password	string (password)	kata sandi untuk masuk
type	string: Credential	jenis parameter eksekusi skrip
username	string	nama pengguna untuk masuk

ScriptExecution

Objek

Instans skrip yang dijalankan oleh pengguna - kustom atau AVS

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nama sumber daya
properties.errors	string[]	Aliran output kesalahan standar dari eksekusi powershell
properties.failureReason	string	Pesan kesalahan jika skrip dapat dijalankan, tetapi jika skrip itu sendiri memiliki kesalahan atau powershell melemparkan pengecualian
properties.finishedAt	string (date-time)	Waktu eksekusi skrip selesai
properties.hiddenParameters	ScriptExecutionParameter[]: PSCredentialExecutionParameter[] ScriptSecureStringExecutionParameter[] ScriptStringExecutionParameter[]	Parameter yang akan disembunyikan/tidak terlihat oleh ARM, seperti kata sandi dan kredensial
properties.information	string[]	Aliran informasi standar keluar dari eksekusi powershell
properties.namedOutputs	object	Kamus yang ditentukan pengguna.
properties.output	string[]	Aliran output standar dari eksekusi powershell
properties.parameters	ScriptExecutionParameter[]: PSCredentialExecutionParameter[] ScriptSecureStringExecutionParameter[] ScriptStringExecutionParameter[]	Parameter yang akan diterima skrip
properties.provisioningState	ScriptExecutionProvisioningState	Status sumber daya eksekusi skrip
properties.retention	string	Waktu hidup untuk sumber daya. Jika tidak disediakan, akan tersedia selama 60 hari
properties.scriptCmdletId	string	Referensi ke sumber daya cmdlet skrip jika pengguna menjalankan skrip AVS
properties.startedAt	string (date-time)	Waktu eksekusi skrip dimulai
properties.submittedAt	string (date-time)	Waktu eksekusi skrip dikirimkan
properties.timeout	string	Batas waktu untuk eksekusi
properties.warnings	string[]	Aliran peringatan standar keluar dari eksekusi powershell
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

ScriptExecutionParameterType

Enumerasi

jenis parameter eksekusi skrip

Nilai	Deskripsi
Value
SecureValue
Credential

ScriptExecutionProvisioningState

Enumerasi

Status provisi Eksekusi Skrip

Nilai	Deskripsi
Succeeded	Sumber daya telah dibuat.
Failed	Pembuatan sumber daya gagal.
Canceled	Pembuatan sumber daya dibatalkan.
Pending	tertunda
Running	sedang berjalan
Cancelling	sedang membatalkan
Cancelled	dibatalkan
Deleting	sedang menghapus

ScriptSecureStringExecutionParameter

Objek

parameter eksekusi nilai teks biasa

Nama	Jenis	Deskripsi
name	string	Nama parameter
secureValue	string (password)	Nilai aman untuk parameter yang dilewatkan, tidak disimpan dalam log
type	string: SecureValue	jenis parameter eksekusi skrip

ScriptStringExecutionParameter

Objek

parameter eksekusi nilai teks biasa

Nama	Jenis	Deskripsi
name	string	Nama parameter
type	string: Value	jenis parameter eksekusi skrip
value	string	Nilai untuk parameter yang diteruskan

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

Bagikan melalui

Script Executions - Create Or Update

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Cakupan

Contoh

ScriptExecutions_CreateOrUpdate

Permintaan sampel

Respon sampel

Definisi

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PSCredentialExecutionParameter

ScriptExecution

ScriptExecutionParameterType

ScriptExecutionProvisioningState

ScriptSecureStringExecutionParameter

ScriptStringExecutionParameter

systemData