Dataset Viewer
text
stringlengths 666
74.1M
|
|---|
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "management.azure.com",
"info": {
"description": "Virtual Machine Image Template",
"title": "VirtualMachineImageTemplate",
"version": "2019-05-01-preview",
"x-apisguru-categories": [
"cloud"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png"
},
"x-origin": [
{
"format": "swagger",
"url": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/preview/2019-05-01-preview/imagebuilder.json",
"version": "2.0"
}
],
"x-preferred": true,
"x-providerName": "azure.com",
"x-serviceName": "imagebuilder",
"x-tags": [
"Azure",
"Microsoft"
]
},
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"securityDefinitions": {
"azure_auth": {
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"description": "Azure Active Directory OAuth2 Flow",
"flow": "implicit",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"type": "oauth2"
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"parameters": {
"ApiVersionParameter": {
"description": "Client Api Version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
"ImageTemplateNameParameter": {
"description": "The name of the image Template",
"in": "path",
"name": "imageTemplateName",
"pattern": "^[A-Za-z0-9-_.]{1,64}$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"LocationParameter": {
"description": "Location of the service.",
"in": "path",
"name": "location",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"ResourceGroupNameParameter": {
"description": "The name of the resource group.",
"in": "path",
"name": "resourceGroupName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"RunOutputNameParameter": {
"description": "The name of the run output",
"in": "path",
"name": "runOutputName",
"pattern": "^[A-Za-z0-9-_.]{1,64}$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"SubscriptionIdParameter": {
"description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription Id forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
}
},
"paths": {
"/providers/Microsoft.VirtualMachineImages/operations": {
"get": {
"description": "Lists available operations for the Microsoft.VirtualMachineImages provider",
"operationId": "Operations_List",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "The operation was successful. The response contains the list of available operations.",
"schema": {
"$ref": "#/definitions/OperationListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
},
"tags": [
"Operations"
],
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.VirtualMachineImages/imageTemplates": {
"get": {
"description": "Gets information about the VM image templates associated with the subscription.",
"operationId": "VirtualMachineImageTemplates_List",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageTemplateListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
},
"tags": [
"VirtualMachineImageTemplate"
],
"x-ms-examples": {
"List images by subscription.": {
"parameters": {
"api-version": "2019-05-01-preview",
"subscriptionId": "{subscription-id}"
},
"responses": {
"200": {
"body": {
"nextLink": "/subscriptions/{subscription-id}/providers/Microsoft.VirtualMachineImages/imageTemplates?api-version=2018-02-01-preview&skip-token=2",
"value": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate",
"location": "westus",
"name": "myImageTemplate",
"properties": {
"customize": [
{
"name": "Shell customization example",
"scriptUri": "https://example.com/path/to/script.sh",
"type": "Shell"
}
],
"distribute": [
{
"artifactTags": {
"tagName": "value"
},
"imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
"location": "1_location",
"runOutputName": "image_it_pir_1",
"type": "ManagedImage"
}
],
"source": {
"sha256Checksum": "120acbca7b3d55465eb9f8ef53ad7365f2997d42d4f83d7cc285bf5c71e1131f",
"sourceUri": "http://redhat.com/path/to/installation.iso",
"type": "ISO"
},
"vmProfile": {
"vmSize": "Standard_D2s_v3"
}
},
"type": "Microsoft.VirtualMachineImages/imageTemplate"
},
{
"id": "/subscriptions/{subscription-id}/resourceGroups/myOtherResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/mySecondImageTemplate",
"location": "westus",
"name": "mySecondImageTemplate",
"properties": {
"customize": [
{
"name": "Shell customization example",
"scriptUri": "https://example.com/path/to/script.sh",
"type": "Shell"
}
],
"distribute": [
{
"artifactTags": {
"stage": "development"
},
"imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/mySecondImage-eus",
"location": "eastus",
"runOutputName": "eus",
"type": "ManagedImage"
}
],
"source": {
"offer": "UbuntuServer",
"publisher": "Canonical",
"sku": "18.04-LTS",
"type": "PlatformImage",
"version": "18.04.201902121"
},
"vmProfile": {
"vmSize": "Standard_D8s_v3"
}
},
"type": "Microsoft.VirtualMachineImages/imageTemplate"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates": {
"get": {
"description": "Gets information about the VM image templates associated with the specified resource group.",
"operationId": "VirtualMachineImageTemplates_ListByResourceGroup",
"parameters": [
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageTemplateListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
},
"tags": [
"VirtualMachineImageTemplate"
],
"x-ms-examples": {
"List images by resource group": {
"parameters": {
"api-version": "2019-05-01-preview",
"resourceGroupName": "myResourceGroup",
"subscriptionId": "{subscription-id}"
},
"responses": {
"200": {
"body": {
"nextLink": "/subscriptions/{subscription-id}/resourceGroup/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates?api-version=2019-05-01-preview&skip-token=2",
"value": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate",
"location": "westus",
"name": "myImageTemplate",
"properties": {
"customize": [
{
"name": "Shell customization example",
"scriptUri": "https://example.com/path/to/script.sh",
"type": "Shell"
}
],
"distribute": [
{
"artifactTags": {
"tagName": "value"
},
"imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
"location": "1_location",
"runOutputName": "image_it_pir_1",
"type": "ManagedImage"
}
],
"source": {
"sha256Checksum": "120acbca7b3d55465eb9f8ef53ad7365f2997d42d4f83d7cc285bf5c71e1131f",
"sourceUri": "http://redhat.com/path/to/installation.iso",
"type": "ISO"
},
"vmProfile": {
"vmSize": "Standard_D2s_v3"
}
},
"type": "Microsoft.VirtualMachineImages/imageTemplate"
},
{
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myOtherImageTemplate",
"location": "eastus",
"name": "myOtherImageTemplate",
"properties": {
"customize": [
{
"name": "Shell customization example",
"scriptUri": "https://example.com/path/to/script.sh",
"type": "Shell"
}
],
"distribute": [
{
"imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/baseimage-cus",
"location": "centralus",
"runOutputName": "singleImage",
"type": "ManagedImage"
},
{
"galleryImageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/gallery/baseimages/images/baseimage",
"replicationRegions": [
"eastus",
"westus"
],
"runOutputName": "gallery",
"type": "SharedImage"
}
],
"source": {
"offer": "UbuntuServer",
"publisher": "Canonical",
"sku": "18.04-LTS",
"type": "PlatformImage",
"version": "18.04.201902121"
},
"vmProfile": {
"vmSize": "Standard_D8s_v3"
}
},
"type": "Microsoft.VirtualMachineImages/imageTemplate"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}": {
"delete": {
"description": "Delete a virtual machine image template",
"operationId": "VirtualMachineImageTemplates_Delete",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ImageTemplateNameParameter"
}
],
"responses": {
"200": {
"description": "The operation was successful."
},
"202": {
"description": "The operation will be completed asynchronously."
},
"204": {
"description": "NoContent -- VM image template does not exist in the subscription."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
},
"tags": [
"VirtualMachineImageTemplate"
],
"x-ms-examples": {
"Delete an Image Template.": {
"parameters": {
"api-version": "2019-05-01-preview",
"imageTemplateName": "myImageTemplate",
"resourceGroupName": "myResourceGroup",
"subscriptionId": "{subscription-id}"
},
"responses": {
"200": {},
"202": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.VirtualMachineImages/locations/{location}/operations/{operation-id}?api-version=2019-05-01-preview"
}
},
"204": {}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
}
},
"get": {
"description": "Get information about a virtual machine image template",
"operationId": "VirtualMachineImageTemplates_Get",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ImageTemplateNameParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageTemplate"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
},
"tags": [
"VirtualMachineImageTemplate"
],
"x-ms-examples": {
"Retrieve an Image Template.": {
"parameters": {
"api-version": "2019-05-01-preview",
"imageTemplateName": "myImageTemplate",
"resourceGroupName": "myResourceGroup",
"subscriptionId": "{subscription-id}"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate",
"location": "westus",
"name": "myImageTemplate",
"properties": {
"customize": [
{
"name": "Shell Customizer Example",
"scriptUri": "https://example.com/path/to/script.sh",
"type": "Shell"
}
],
"distribute": [
{
"artifactTags": {
"tagName": "value"
},
"imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
"location": "1_location",
"runOutputName": "image_it_pir_1",
"type": "ManagedImage"
}
],
"source": {
"sha256Checksum": "120acbca7b3d55465eb9f8ef53ad7365f2997d42d4f83d7cc285bf5c71e1131f",
"sourceUri": "http://redhat.com/path/to/installation.iso",
"type": "ISO"
},
"vmProfile": {
"vmSize": "Standard_D2s_v3"
}
},
"type": "Microsoft.VirtualMachineImages/imageTemplate"
}
}
}
}
}
},
"patch": {
"description": "Update the tags for this Virtual Machine Image Template",
"operationId": "VirtualMachineImageTemplates_Update",
"parameters": [
{
"description": "Additional parameters for Image Template update.",
"in": "body",
"name": "parameters",
"required": true,
"schema": {
"$ref": "#/definitions/ImageTemplateUpdateParameters"
}
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ImageTemplateNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageTemplate"
}
},
"202": {
"description": "The operation will be completed asynchronously."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
},
"tags": [
"VirtualMachineImageTemplate"
],
"x-ms-examples": {
"Remove identities for an Image Template.": {
"parameters": {
"api-version": "2019-05-01-preview",
"imageTemplateName": "myImageTemplate",
"parameters": {
"identity": {
"type": "None"
}
},
"resourceGroupName": "myResourceGroup",
"subscriptionId": "{subscription-id}"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate",
"identity": {
"type": "None"
},
"location": "westus",
"name": "myImageTemplate",
"properties": {
"customize": [
{
"name": "Shell customization example",
"scriptUri": "https://example.com/path/to/script.sh",
"type": "Shell"
}
],
"distribute": [
{
"artifactTags": {
"tagName": "value"
},
"imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
"location": "1_location",
"runOutputName": "image_it_pir_1",
"type": "ManagedImage"
}
],
"source": {
"sha256Checksum": "120acbca7b3d55465eb9f8ef53ad7365f2997d42d4f83d7cc285bf5c71e1131f",
"sourceUri": "http://redhat.com/path/to/installation.iso",
"type": "ISO"
},
"vmProfile": {
"vmSize": "Standard_D2s_v3"
}
},
"tags": {
"new-tag": "new-value"
},
"type": "Microsoft.VirtualMachineImages/imageTemplate"
}
},
"202": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.VirtualMachineImages/locations/{location}/operations/{operation-id}?api-version=2019-05-01-preview"
}
}
}
},
"Update the tags for an Image Template.": {
"parameters": {
"api-version": "2019-05-01-preview",
"imageTemplateName": "myImageTemplate",
"parameters": {
"tags": {
"new-tag": "new-value"
}
},
"resourceGroupName": "myResourceGroup",
"subscriptionId": "{subscription-id}"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate",
"location": "westus",
"name": "myImageTemplate",
"properties": {
"customize": [
{
"name": "Shell customization example",
"scriptUri": "https://example.com/path/to/script.sh",
"type": "Shell"
}
],
"distribute": [
{
"artifactTags": {
"tagName": "value"
},
"imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
"location": "1_location",
"runOutputName": "image_it_pir_1",
"type": "ManagedImage"
}
],
"source": {
"sha256Checksum": "120acbca7b3d55465eb9f8ef53ad7365f2997d42d4f83d7cc285bf5c71e1131f",
"sourceUri": "http://redhat.com/path/to/installation.iso",
"type": "ISO"
},
"vmProfile": {
"vmSize": "Standard_D2s_v3"
}
},
"tags": {
"new-tag": "new-value"
},
"type": "Microsoft.VirtualMachineImages/imageTemplate"
}
},
"202": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.VirtualMachineImages/locations/{location}/operations/{operation-id}?api-version=2019-05-01-preview"
}
}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
}
},
"put": {
"description": "Create or update a virtual machine image template",
"operationId": "VirtualMachineImageTemplates_CreateOrUpdate",
"parameters": [
{
"description": "Parameters supplied to the CreateImageTemplate operation",
"in": "body",
"name": "parameters",
"required": true,
"schema": {
"$ref": "#/definitions/ImageTemplate"
}
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ImageTemplateNameParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageTemplate"
}
},
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/ImageTemplate"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
},
"tags": [
"VirtualMachineImageTemplate"
],
"x-ms-examples": {
"Create an Image Template with a user assigned identity configured": {
"parameters": {
"api-version": "2019-05-01-preview",
"imageTemplateName": "myImageTemplate",
"parameters": {
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": {}
}
},
"location": "westus",
"properties": {
"customize": [
{
"name": "Shell Customizer Example",
"scriptUri": "https://example.com/path/to/script.sh",
"type": "Shell"
}
],
"distribute": [
{
"artifactTags": {
"tagName": "value"
},
"imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
"location": "1_location",
"runOutputName": "image_it_pir_1",
"type": "ManagedImage"
}
],
"source": {
"imageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/images/source_image",
"type": "ManagedImage"
},
"vmProfile": {
"vmSize": "Standard_D2s_v3"
}
},
"tags": {
"imagetemplate_tag1": "IT_T1",
"imagetemplate_tag2": "IT_T2"
}
},
"resourceGroupName": "myResourceGroup",
"subscriptionId": "{subscription-id}"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate",
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": {
"clientId": "00000000-0000-0000-0000-000000000000",
"principalId": "00000000-0000-0000-0000-000000000000"
}
}
},
"location": "westus",
"name": "myImageTemplate",
"properties": {
"customize": [
{
"name": "Shell Customizer Example",
"scriptUri": "https://example.com/path/to/script.sh",
"type": "Shell"
}
],
"distribute": [
{
"artifactTags": {
"tagName": "value"
},
"imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
"location": "1_location",
"runOutputName": "image_it_pir_1",
"type": "ManagedImage"
}
],
"source": {
"imageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/images/source_image",
"type": "ManagedImage"
},
"vmProfile": {
"vmSize": "Standard_D2s_v3"
}
},
"type": "Microsoft.VirtualMachineImages/imageTemplate"
}
},
"201": {
"body": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate",
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": {
"clientId": "00000000-0000-0000-0000-000000000000",
"principalId": "00000000-0000-0000-0000-000000000000"
}
}
},
"location": "westus",
"name": "myImageTemplate",
"properties": {
"customize": [
{
"name": "Shell Customizer Example",
"scriptUri": "https://example.com/path/to/script.sh",
"type": "Shell"
}
],
"distribute": [
{
"artifactTags": {
"tagName": "value"
},
"imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
"location": "1_location",
"runOutputName": "image_it_pir_1",
"type": "ManagedImage"
}
],
"source": {
"imageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/images/source_image",
"type": "ManagedImage"
},
"vmProfile": {
"vmSize": "Standard_D2s_v3"
}
},
"type": "Microsoft.VirtualMachineImages/imageTemplate"
}
}
}
},
"Create an Image Template.": {
"parameters": {
"api-version": "2019-05-01-preview",
"imageTemplateName": "myImageTemplate",
"parameters": {
"location": "westus",
"properties": {
"customize": [
{
"name": "Shell Customizer Example",
"scriptUri": "https://example.com/path/to/script.sh",
"type": "Shell"
}
],
"distribute": [
{
"artifactTags": {
"tagName": "value"
},
"imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
"location": "1_location",
"runOutputName": "image_it_pir_1",
"type": "ManagedImage"
}
],
"source": {
"imageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/images/source_image",
"type": "ManagedImage"
},
"vmProfile": {
"vmSize": "Standard_D2s_v3"
}
},
"tags": {
"imagetemplate_tag1": "IT_T1",
"imagetemplate_tag2": "IT_T2"
}
},
"resourceGroupName": "myResourceGroup",
"subscriptionId": "{subscription-id}"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate",
"location": "westus",
"name": "myImageTemplate",
"properties": {
"customize": [
{
"name": "Shell Customizer Example",
"scriptUri": "https://example.com/path/to/script.sh",
"type": "Shell"
}
],
"distribute": [
{
"artifactTags": {
"tagName": "value"
},
"imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
"location": "1_location",
"runOutputName": "image_it_pir_1",
"type": "ManagedImage"
}
],
"source": {
"imageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/images/source_image",
"type": "ManagedImage"
},
"vmProfile": {
"vmSize": "Standard_D2s_v3"
}
},
"type": "Microsoft.VirtualMachineImages/imageTemplate"
}
},
"201": {
"body": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate",
"location": "westus",
"name": "myImageTemplate",
"properties": {
"customize": [
{
"name": "Shell Customizer Example",
"scriptUri": "https://example.com/path/to/script.sh",
"type": "Shell"
}
],
"distribute": [
{
"artifactTags": {
"tagName": "value"
},
"imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
"location": "1_location",
"runOutputName": "image_it_pir_1",
"type": "ManagedImage"
}
],
"source": {
"imageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/images/source_image",
"type": "ManagedImage"
},
"vmProfile": {
"vmSize": "Standard_D2s_v3"
}
},
"type": "Microsoft.VirtualMachineImages/imageTemplate"
}
}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/run": {
"post": {
"description": "Create artifacts from a existing image template",
"operationId": "VirtualMachineImageTemplates_Run",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ImageTemplateNameParameter"
}
],
"responses": {
"202": {
"description": "The operation will be completed asynchronously."
},
"204": {
"description": "The operation was successful."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
},
"tags": [
"VirtualMachineImageTemplate"
],
"x-ms-examples": {
"Create image(s) from existing imageTemplate.": {
"parameters": {
"api-version": "2019-05-01-preview",
"imageTemplateName": "myImageTemplate",
"resourceGroupName": "myResourceGroup",
"subscriptionId": "{subscription-id}"
},
"responses": {
"202": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.VirtualMachineImages/locations/{location}/operations/{operation-id}?api-version=2019-05-01-preview"
}
},
"204": {}
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/runOutputs": {
"get": {
"description": "List all run outputs for the specified Image Template resource",
"operationId": "VirtualMachineImageTemplates_ListRunOutputs",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ImageTemplateNameParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RunOutputCollection"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
},
"tags": [
"VirtualMachineImageTemplate"
],
"x-ms-examples": {
"Retrieve a list of all outputs created by the last run of an Image Template": {
"parameters": {
"api-version": "2019-05-01-preview",
"imageTemplateName": "myImageTemplate",
"resourceGroupName": "myResourceGroup",
"subscriptionId": "{subscription-id}"
},
"responses": {
"200": {
"body": {
"nextLink": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate/runOutputs?api-version=2018-02-01-preview&$skipToken=3",
"value": [
{
"id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate/runOutputs/myManagedImageOutput",
"name": "myManagedImageOutput",
"properties": {
"artifactId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/output_managed_image",
"provisioningState": "Succeeded"
},
"type": "Microsoft.VirtualMachineImages/imageTemplates/runOutputs"
},
{
"id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate/runOutputs/mySharedImageOutput",
"name": "mySharedImageOutput",
"properties": {
"artifactId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/galleries/Gallery1/images/SharedImageOutput/imageversions/1.2.3",
"provisioningState": "Succeeded"
},
"type": "Microsoft.VirtualMachineImages/imageTemplates/runOutputs"
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}/runOutputs/{runOutputName}": {
"get": {
"description": "Get the specified run output for the specified image template resource",
"operationId": "VirtualMachineImageTemplates_GetRunOutput",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ImageTemplateNameParameter"
},
{
"$ref": "#/parameters/RunOutputNameParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/RunOutput"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ApiError"
}
}
},
"tags": [
"VirtualMachineImageTemplate"
],
"x-ms-examples": {
"Retrieve single runOutput": {
"parameters": {
"api-version": "2019-05-01-preview",
"imageTemplateName": "myImageTemplate",
"resourceGroupName": "myResourceGroup",
"runOutputName": "myManagedImageOutput",
"subscriptionId": "{subscription-id}"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate/runOutputs/myManagedImageOutput",
"name": "myManagedImageOutput",
"properties": {
"artifactId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/output_managed_image",
"provisioningState": "Succeeded"
},
"type": "Microsoft.VirtualMachineImages/imageTemplates/runOutputs"
}
}
}
}
}
}
}
},
"definitions": {
"ApiError": {
"description": "Api error.",
"properties": {
"code": {
"description": "The error code.",
"type": "string"
},
"details": {
"description": "The Api error details",
"items": {
"$ref": "#/definitions/ApiErrorBase"
},
"type": "array"
},
"innerError": {
"$ref": "#/definitions/InnerError",
"description": "The Api inner error"
},
"message": {
"description": "The error message.",
"type": "string"
},
"target": {
"description": "The target of the particular error.",
"type": "string"
}
}
},
"ApiErrorBase": {
"description": "Api error base.",
"properties": {
"code": {
"description": "The error code.",
"type": "string"
},
"message": {
"description": "The error message.",
"type": "string"
},
"target": {
"description": "The target of the particular error.",
"type": "string"
}
}
},
"ImageTemplate": {
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"description": "Image template is an ARM resource managed by Microsoft.VirtualMachineImages provider",
"properties": {
"identity": {
"$ref": "#/definitions/ImageTemplateIdentity",
"description": "The identity of the image template, if configured."
},
"properties": {
"$ref": "#/definitions/ImageTemplateProperties",
"description": "The properties of the image template",
"x-ms-client-flatten": true
}
}
},
"ImageTemplateCustomizer": {
"description": "Describes a unit of image customization",
"discriminator": "type",
"properties": {
"name": {
"description": "Friendly Name to provide context on what this customization step does",
"type": "string"
},
"type": {
"description": "The type of customization tool you want to use on the Image. For example, \"Shell\" can be shell customizer",
"type": "string"
}
},
"required": [
"type"
]
},
"ImageTemplateDistributor": {
"description": "Generic distribution object",
"discriminator": "type",
"properties": {
"artifactTags": {
"additionalProperties": {
"type": "string"
},
"description": "Tags that will be applied to the artifact once it has been created/updated by the distributor.",
"type": "object"
},
"runOutputName": {
"description": "The name to be used for the associated RunOutput.",
"pattern": "^[A-Za-z0-9-_.]{1,64}$",
"type": "string"
},
"type": {
"description": "Type of distribution.",
"type": "string"
}
},
"required": [
"type",
"runOutputName"
],
"type": "object"
},
"ImageTemplateFileCustomizer": {
"allOf": [
{
"$ref": "#/definitions/ImageTemplateCustomizer"
}
],
"description": "Uploads files to VMs (Linux, Windows). Corresponds to Packer file provisioner",
"properties": {
"destination": {
"description": "The absolute path to a file (with nested directory structures already created) where the file (from sourceUri) will be uploaded to in the VM",
"type": "string"
},
"sha256Checksum": {
"description": "SHA256 checksum of the file provided in the sourceUri field above",
"type": "string"
},
"sourceUri": {
"description": "The URI of the file to be uploaded for customizing the VM. It can be a github link, SAS URI for Azure Storage, etc",
"type": "string"
}
},
"x-ms-discriminator-value": "File"
},
"ImageTemplateIdentity": {
"description": "Identity for the image template.",
"properties": {
"type": {
"description": "The type of identity used for the image template. The type 'None' will remove any identities from the image template.",
"enum": [
"UserAssigned",
"None"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ResourceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"properties": {
"clientId": {
"description": "The client id of user assigned identity.",
"readOnly": true,
"type": "string"
},
"principalId": {
"description": "The principal id of user assigned identity.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"description": "The list of user identities associated with the image template. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
"type": "object"
}
}
},
"ImageTemplateIsoSource": {
"allOf": [
{
"$ref": "#/definitions/ImageTemplateSource"
}
],
"description": "Describes an image source that is an installation ISO. Currently only supports Red Hat Enterprise Linux 7.2-7.5 ISO's.",
"properties": {
"sha256Checksum": {
"description": "SHA256 Checksum of the ISO image.",
"type": "string"
},
"sourceUri": {
"description": "URI to get the ISO image. This URI has to be accessible to the resource provider at the time of the image template creation.",
"type": "string"
}
},
"required": [
"sourceUri",
"sha256Checksum"
],
"x-ms-discriminator-value": "ISO"
},
"ImageTemplateLastRunStatus": {
"description": "Describes the latest status of running an image template",
"properties": {
"endTime": {
"description": "End time of the last run (UTC)",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Verbose information about the last run state",
"type": "string"
},
"runState": {
"description": "State of the last run",
"enum": [
"Running",
"Succeeded",
"PartiallySucceeded",
"Failed"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RunState"
}
},
"runSubState": {
"description": "Sub-state of the last run",
"enum": [
"Queued",
"Building",
"Customizing",
"Distributing"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "RunSubState"
}
},
"startTime": {
"description": "Start time of the last run (UTC)",
"format": "date-time",
"type": "string"
}
}
},
"ImageTemplateListResult": {
"description": "The result of List image templates operation",
"properties": {
"nextLink": {
"description": "The continuation token.",
"type": "string"
},
"value": {
"description": "An array of image templates",
"items": {
"$ref": "#/definitions/ImageTemplate"
},
"type": "array"
}
}
},
"ImageTemplateManagedImageDistributor": {
"allOf": [
{
"$ref": "#/definitions/ImageTemplateDistributor"
}
],
"description": "Distribute as a Managed Disk Image.",
"properties": {
"imageId": {
"description": "Resource Id of the Managed Disk Image",
"type": "string"
},
"location": {
"description": "Azure location for the image, should match if image already exists",
"type": "string"
}
},
"required": [
"imageId",
"location"
],
"type": "object",
"x-ms-discriminator-value": "ManagedImage"
},
"ImageTemplateManagedImageSource": {
"allOf": [
{
"$ref": "#/definitions/ImageTemplateSource"
}
],
"description": "Describes an image source that is a managed image in customer subscription.",
"properties": {
"imageId": {
"description": "ARM resource id of the managed image in customer subscription",
"type": "string"
}
},
"required": [
"imageId"
],
"x-ms-discriminator-value": "ManagedImage"
},
"ImageTemplatePlatformImageSource": {
"allOf": [
{
"$ref": "#/definitions/ImageTemplateSource"
}
],
"description": "Describes an image source from [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages).",
"properties": {
"offer": {
"description": "Image offer from the [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages).",
"type": "string"
},
"publisher": {
"description": "Image Publisher in [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages).",
"type": "string"
},
"sku": {
"description": "Image sku from the [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages).",
"type": "string"
},
"version": {
"description": "Image version from the [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages).",
"type": "string"
}
},
"x-ms-discriminator-value": "PlatformImage"
},
"ImageTemplatePowerShellCustomizer": {
"allOf": [
{
"$ref": "#/definitions/ImageTemplateCustomizer"
}
],
"description": "Runs the specified PowerShell on the VM (Windows). Corresponds to Packer powershell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.",
"properties": {
"inline": {
"description": "Array of PowerShell commands to execute",
"items": {
"type": "string"
},
"type": "array"
},
"runElevated": {
"description": "If specified, the PowerShell script will be run with elevated privileges",
"type": "boolean"
},
"scriptUri": {
"description": "URI of the PowerShell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc",
"type": "string"
},
"sha256Checksum": {
"description": "SHA256 checksum of the power shell script provided in the scriptUri field above",
"type": "string"
},
"validExitCodes": {
"description": "Valid exit codes for the PowerShell script. [Default: 0]",
"items": {
"type": "integer"
},
"type": "array"
}
},
"x-ms-discriminator-value": "PowerShell"
},
"ImageTemplateProperties": {
"description": "Describes the properties of an image template",
"properties": {
"buildTimeoutInMinutes": {
"description": "Maximum duration to wait while building the image template. Omit or specify 0 to use the default (4 hours).",
"maximum": 960,
"minimum": 0,
"type": "integer"
},
"customize": {
"description": "Specifies the properties used to describe the customization steps of the image, like Image source etc",
"items": {
"$ref": "#/definitions/ImageTemplateCustomizer"
},
"type": "array"
},
"distribute": {
"description": "The distribution targets where the image output needs to go to.",
"items": {
"$ref": "#/definitions/ImageTemplateDistributor"
},
"type": "array"
},
"lastRunStatus": {
"$ref": "#/definitions/ImageTemplateLastRunStatus",
"description": "State of 'run' that is currently executing or was last executed.",
"readOnly": true
},
"provisioningError": {
"$ref": "#/definitions/ProvisioningError",
"description": "Provisioning error, if any",
"readOnly": true
},
"provisioningState": {
"$ref": "#/definitions/ProvisioningState",
"description": "Provisioning state of the resource",
"readOnly": true
},
"source": {
"$ref": "#/definitions/ImageTemplateSource",
"description": "Specifies the properties used to describe the source image."
},
"vmProfile": {
"$ref": "#/definitions/ImageTemplateVmProfile",
"description": "Describes how virtual machine is set up to build images"
}
},
"required": [
"source",
"distribute"
]
},
"ImageTemplateRestartCustomizer": {
"allOf": [
{
"$ref": "#/definitions/ImageTemplateCustomizer"
}
],
"description": "Reboots a VM and waits for it to come back online (Windows). Corresponds to Packer windows-restart provisioner",
"properties": {
"restartCheckCommand": {
"description": "Command to check if restart succeeded [Default: '']",
"type": "string"
},
"restartCommand": {
"description": "Command to execute the restart [Default: 'shutdown /r /f /t 0 /c \"packer restart\"']",
"type": "string"
},
"restartTimeout": {
"description": "Restart timeout specified as a string of magnitude and unit, e.g. '5m' (5 minutes) or '2h' (2 hours) [Default: '5m']",
"type": "string"
}
},
"x-ms-discriminator-value": "WindowsRestart"
},
"ImageTemplateSharedImageDistributor": {
"allOf": [
{
"$ref": "#/definitions/ImageTemplateDistributor"
}
],
"description": "Distribute via Shared Image Gallery.",
"properties": {
"galleryImageId": {
"description": "Resource Id of the Shared Image Gallery image",
"type": "string"
},
"replicationRegions": {
"description": "A list of regions that the image will be replicated to",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"galleryImageId",
"replicationRegions"
],
"type": "object",
"x-ms-discriminator-value": "SharedImage"
},
"ImageTemplateSharedImageVersionSource": {
"allOf": [
{
"$ref": "#/definitions/ImageTemplateSource"
}
],
"description": "Describes an image source that is an image version in a shared image gallery.",
"properties": {
"imageVersionId": {
"description": "ARM resource id of the image version in the shared image gallery",
"type": "string"
}
},
"required": [
"imageVersionId"
],
"x-ms-discriminator-value": "SharedImageVersion"
},
"ImageTemplateShellCustomizer": {
"allOf": [
{
"$ref": "#/definitions/ImageTemplateCustomizer"
}
],
"description": "Runs a shell script during the customization phase (Linux). Corresponds to Packer shell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified.",
"properties": {
"inline": {
"description": "Array of shell commands to execute",
"items": {
"type": "string"
},
"type": "array"
},
"scriptUri": {
"description": "URI of the shell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc",
"type": "string"
},
"sha256Checksum": {
"description": "SHA256 checksum of the shell script provided in the scriptUri field",
"type": "string"
}
},
"x-ms-discriminator-value": "Shell"
},
"ImageTemplateSource": {
"description": "Describes a virtual machine image source for building, customizing and distributing",
"discriminator": "type",
"properties": {
"type": {
"description": "Specifies the type of source image you want to start with.",
"type": "string"
}
},
"required": [
"type"
]
},
"ImageTemplateUpdateParameters": {
"description": "Parameters for updating an image template.",
"properties": {
"identity": {
"$ref": "#/definitions/ImageTemplateIdentity",
"description": "The identity of the image template, if configured."
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "The user-specified tags associated with the image template.",
"type": "object"
}
}
},
"ImageTemplateVhdDistributor": {
"allOf": [
{
"$ref": "#/definitions/ImageTemplateDistributor"
}
],
"description": "Distribute via VHD in a storage account.",
"type": "object",
"x-ms-discriminator-value": "VHD"
},
"ImageTemplateVmProfile": {
"description": "Describes the virtual machine used to build, customize and capture images",
"properties": {
"vmSize": {
"description": "Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2).",
"type": "string"
}
}
},
"InnerError": {
"description": "Inner error details.",
"properties": {
"errorDetail": {
"description": "The internal error message or exception dump.",
"type": "string"
},
"exceptionType": {
"description": "The exception type.",
"type": "string"
}
}
},
"Operation": {
"properties": {
"display": {
"properties": {
"description": {
"title": "The friendly name of the operation",
"type": "string"
},
"operation": {
"description": "For example: read, write, delete, or listKeys/action",
"title": "The operation type.",
"type": "string"
},
"provider": {
"title": "Friendly name of the resource provider.",
"type": "string"
},
"resource": {
"title": "The resource type on which the operation is performed.",
"type": "string"
}
},
"title": "The object that describes the operation."
},
"name": {
"description": "This is of the format {provider}/{resource}/{operation}",
"title": "The operation name.",
"type": "string"
},
"origin": {
"title": "The intended executor of the operation.",
"type": "string"
},
"properties": {
"title": "Properties of the operation.",
"type": "object"
}
},
"title": "A REST API operation",
"type": "object"
},
"OperationListResult": {
"properties": {
"nextLink": {
"title": "The URL to get the next set of operation list results if there are any.",
"type": "string"
},
"value": {
"items": {
"$ref": "#/definitions/Operation"
},
"title": "The list of operations supported by the resource provider.",
"type": "array"
}
},
"title": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results."
},
"ProvisioningError": {
"description": "Describes the error happened when create or update an image template",
"properties": {
"message": {
"description": "Verbose error message about the provisioning failure",
"type": "string"
},
"provisioningErrorCode": {
"description": "Error code of the provisioning failure",
"enum": [
"BadSourceType",
"BadPIRSource",
"BadISOSource",
"BadManagedImageSource",
"BadSharedImageVersionSource",
"BadCustomizerType",
"UnsupportedCustomizerType",
"NoCustomizerScript",
"BadDistributeType",
"BadSharedImageDistribute",
"ServerError",
"Other"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningErrorCode"
}
}
}
},
"ProvisioningState": {
"description": "Provisioning state of the resource",
"enum": [
"Creating",
"Updating",
"Succeeded",
"Failed",
"Deleting"
],
"type": "string",
"x-ms-enum": {
"modelAsString": false,
"name": "ProvisioningState"
}
},
"Resource": {
"description": "The Resource model definition.",
"properties": {
"id": {
"description": "Resource Id",
"readOnly": true,
"type": "string"
},
"location": {
"description": "Resource location",
"type": "string",
"x-ms-mutability": [
"create",
"read"
]
},
"name": {
"description": "Resource name",
"readOnly": true,
"type": "string"
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags",
"type": "object"
},
"type": {
"description": "Resource type",
"readOnly": true,
"type": "string"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true
},
"RunOutput": {
"allOf": [
{
"$ref": "#/definitions/SubResource"
}
],
"description": "Represents an output that was created by running an image template.",
"properties": {
"properties": {
"$ref": "#/definitions/RunOutputProperties",
"description": "The properties of the run output",
"x-ms-client-flatten": true
}
}
},
"RunOutputCollection": {
"description": "The result of List run outputs operation",
"properties": {
"nextLink": {
"description": "The continuation token.",
"type": "string"
},
"value": {
"description": "An array of run outputs",
"items": {
"$ref": "#/definitions/RunOutput"
},
"type": "array"
}
}
},
"RunOutputProperties": {
"description": "Describes the properties of a run output",
"properties": {
"artifactId": {
"description": "The resource id of the artifact.",
"type": "string"
},
"artifactUri": {
"description": "The location URI of the artifact.",
"type": "string"
},
"provisioningState": {
"$ref": "#/definitions/ProvisioningState",
"description": "Provisioning state of the resource",
"readOnly": true
}
}
},
"SubResource": {
"description": "The Sub Resource model definition.",
"properties": {
"id": {
"description": "Resource Id",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Resource name",
"type": "string"
},
"type": {
"description": "Resource type",
"readOnly": true,
"type": "string"
}
},
"required": [
"name"
]
}
}
}
|
{
"openapi": "3.0.1",
"servers": [
{
"url": "https://weather.visualcrossing.com"
}
],
"info": {
"contact": {
"email": "[email protected]",
"name": "Visual Crossing Corporation",
"url": "https://www.visualcrossing.com/weather-api",
"x-twitter": "visualcrossing"
},
"description": "Weather Forecast and Historical Weather Data via RESTful API.",
"license": {
"name": "Visual Crossing Weather API",
"url": "https://www.visualcrossing.com/weather-api"
},
"termsOfService": "https://www.visualcrossing.com/weather-services-terms",
"title": "Visual Crossing Weather API",
"version": "4.6",
"x-apisguru-categories": [
"location"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_twitter.com_visualcrossing_profile_image.jpeg"
},
"x-origin": [
{
"format": "openapi",
"url": "https://www.visualcrossing.com/weather/specs/visualcrossing-weather-api-openapi.json",
"version": "3.0"
}
],
"x-providerName": "visualcrossing.com",
"x-serviceName": "weather"
},
"externalDocs": {
"description": "Full Timeline Weather API Documentation",
"url": "https://www.visualcrossing.com/resources/documentation/weather-api/timeline-weather-api/"
},
"paths": {
"/VisualCrossingWebServices/rest/services/timeline/{location}": {
"get": {
"description": "Seamless access to daily and hourly historical and forecast weather data plus weather alerts, events and current conditions.",
"parameters": [
{
"description": "Locaton of interest as an address, partial address or decimal latitude,longtude value",
"example": "London,UK",
"in": "path",
"name": "location",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "data format of the output either json or CSV",
"example": "json",
"in": "query",
"name": "contentType",
"schema": {
"type": "string"
}
},
{
"example": "us",
"in": "query",
"name": "unitGroup",
"schema": {
"type": "string"
}
},
{
"description": "data to include in the output (required for CSV format - days,hours,alerts,current,events )",
"example": "days",
"in": "query",
"name": "include",
"schema": {
"type": "string"
}
},
{
"description": "Language to use for weather descriptions",
"example": "us",
"in": "query",
"name": "lang",
"schema": {
"type": "string"
}
},
{
"example": "INSERT_YOUR_KEY",
"in": "query",
"name": "key",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Auto generated using Swagger Inspector"
}
},
"servers": [
{
"url": "https://weather.visualcrossing.com"
}
],
"summary": "Historical and Forecast Weather API",
"tags": [
"Timeline Weather API (15-day forecast request)"
]
},
"servers": [
{
"url": "https://weather.visualcrossing.com"
}
]
},
"/VisualCrossingWebServices/rest/services/timeline/{location}/{startdate}": {
"get": {
"description": "Seamless access to daily and hourly historical and forecast weather data plus weather alerts, events and current conditions.",
"parameters": [
{
"example": "London,UK",
"in": "path",
"name": "location",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "2022-02-01T00:00:00.000Z",
"in": "path",
"name": "startdate",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "data format of the output either json or CSV",
"example": "json",
"in": "query",
"name": "contentType",
"schema": {
"type": "string"
}
},
{
"example": "us",
"in": "query",
"name": "unitGroup",
"schema": {
"type": "string"
}
},
{
"description": "data to include in the output (required for CSV format - days,hours,alerts,current,events )",
"example": "days",
"in": "query",
"name": "include",
"schema": {
"type": "string"
}
},
{
"description": "Language to use for weather descriptions",
"example": "us",
"in": "query",
"name": "lang",
"schema": {
"type": "string"
}
},
{
"example": "INSERT_YOUR_KEY",
"in": "query",
"name": "key",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Auto generated using Swagger Inspector"
}
},
"servers": [
{
"url": "https://weather.visualcrossing.com"
}
],
"summary": "Historical and Forecast Weather API",
"tags": [
"Timeline Weather API (single date request)"
]
},
"servers": [
{
"url": "https://weather.visualcrossing.com"
}
]
},
"/VisualCrossingWebServices/rest/services/timeline/{location}/{startdate}/{enddate}": {
"get": {
"description": "Seamless access to daily and hourly historical and forecast weather data plus weather alerts, events and current conditions.",
"parameters": [
{
"example": "London,UK",
"in": "path",
"name": "location",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "2022-02-01T00:00:00.000Z",
"in": "path",
"name": "startdate",
"required": true,
"schema": {
"type": "string"
}
},
{
"example": "2022-03-01T00:00:00.000Z",
"in": "path",
"name": "enddate",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "data format of the output either json or CSV",
"example": "json",
"in": "query",
"name": "contentType",
"schema": {
"type": "string"
}
},
{
"example": "us",
"in": "query",
"name": "unitGroup",
"schema": {
"type": "string"
}
},
{
"description": "data to include in the output (required for CSV format - days,hours,alerts,current,events )",
"example": "days",
"in": "query",
"name": "include",
"schema": {
"type": "string"
}
},
{
"description": "Language to use for weather descriptions",
"example": "us",
"in": "query",
"name": "lang",
"schema": {
"type": "string"
}
},
{
"example": "INSERT_YOUR_KEY",
"in": "query",
"name": "key",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Auto generated using Swagger Inspector"
}
},
"servers": [
{
"url": "https://weather.visualcrossing.com"
}
],
"summary": "Historical and Forecast Weather API",
"tags": [
"Timeline Weather API (date range request)"
]
},
"servers": [
{
"url": "https://weather.visualcrossing.com"
}
]
},
"/VisualCrossingWebServices/rest/services/weatherdata/forecast": {
"get": {
"description": "Provides access to weather forecast information. The forecast is available for up to 15 days at the hourly, 12 hour and daily summary level.",
"parameters": [
{
"example": "false",
"in": "query",
"name": "sendAsDatasource",
"schema": {
"type": "boolean"
}
},
{
"example": "false",
"in": "query",
"name": "allowAsynch",
"schema": {
"type": "boolean"
}
},
{
"example": "false",
"in": "query",
"name": "shortColumnNames",
"schema": {
"type": "boolean"
}
},
{
"example": "Sterling%2C%20VA%2C%20US",
"in": "query",
"name": "locations",
"schema": {
"type": "string"
}
},
{
"example": "24",
"in": "query",
"name": "aggregateHours",
"schema": {
"type": "string"
}
},
{
"example": "json",
"in": "query",
"name": "contentType",
"schema": {
"type": "string"
}
},
{
"example": "us",
"in": "query",
"name": "unitGroup",
"schema": {
"type": "string"
}
},
{
"example": "INSERT_YOUR_KEY",
"in": "query",
"name": "key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Auto generated using Swagger Inspector"
}
},
"servers": [
{
"url": "https://weather.visualcrossing.com"
}
],
"summary": "Weather Forecast API",
"tags": [
"Weather Forecast"
]
},
"servers": [
{
"url": "https://weather.visualcrossing.com"
}
]
},
"/VisualCrossingWebServices/rest/services/weatherdata/history": {
"get": {
"description": "The weather history data is suitable for retrieving hourly or daily historical weather records.",
"parameters": [
{
"example": "-1",
"in": "query",
"name": "maxDistance",
"schema": {
"type": "string"
}
},
{
"example": "false",
"in": "query",
"name": "shortColumnNames",
"schema": {
"type": "boolean"
}
},
{
"example": "2020-02-04T00%3A00%3A00",
"in": "query",
"name": "endDateTime",
"schema": {
"type": "string"
}
},
{
"example": "24",
"in": "query",
"name": "aggregateHours",
"schema": {
"type": "string"
}
},
{
"example": "false",
"in": "query",
"name": "collectStationContributions",
"schema": {
"type": "boolean"
}
},
{
"example": "2020-01-28T00%3A00%3A00",
"in": "query",
"name": "startDateTime",
"schema": {
"type": "string"
}
},
{
"example": "-1",
"in": "query",
"name": "maxStations",
"schema": {
"type": "string"
}
},
{
"example": "false",
"in": "query",
"name": "allowAsynch",
"schema": {
"type": "boolean"
}
},
{
"example": "Sterling%2C%20VA%2C%20US",
"in": "query",
"name": "locations",
"schema": {
"type": "string"
}
},
{
"example": "false",
"in": "query",
"name": "includeNormals",
"schema": {
"type": "boolean"
}
},
{
"example": "json",
"in": "query",
"name": "contentType",
"schema": {
"type": "string"
}
},
{
"example": "us",
"in": "query",
"name": "unitGroup",
"schema": {
"type": "string"
}
},
{
"example": "INSERT_YOUR_KEY",
"in": "query",
"name": "key",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Auto generated using Swagger Inspector"
}
},
"servers": [
{
"url": "https://weather.visualcrossing.com"
}
],
"summary": "Retrieves hourly or daily historical weather records.",
"tags": [
"Historical Weather"
]
},
"servers": [
{
"url": "https://weather.visualcrossing.com"
}
]
}
}
}
|
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "management.azure.com",
"info": {
"description": "The APIs listed in this specification can be used to manage Deployment Scripts resource through the Azure Resource Manager.",
"title": "DeploymentScriptsClient",
"version": "2019-10-01-preview",
"x-apisguru-categories": [
"cloud"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png"
},
"x-origin": [
{
"format": "swagger",
"url": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/preview/2019-10-01-preview/deploymentScripts.json",
"version": "2.0"
}
],
"x-providerName": "azure.com",
"x-serviceName": "resources-deploymentScripts",
"x-tags": [
"Azure",
"Microsoft"
]
},
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"securityDefinitions": {
"azure_auth": {
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"description": "Azure Active Directory OAuth2 Flow",
"flow": "implicit",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"type": "oauth2"
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"parameters": {
"ApiVersionParameter": {
"description": "Client Api version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string",
"x-ms-parameter-location": "client"
},
"ResourceGroupNameParameter": {
"description": "The name of the resource group. The name is case insensitive.",
"in": "path",
"maxLength": 90,
"minLength": 1,
"name": "resourceGroupName",
"pattern": "^[-\\w\\._\\(\\)]+$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"ScriptNameParameter": {
"description": "Name of the deployment script.",
"in": "path",
"maxLength": 90,
"minLength": 1,
"name": "scriptName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"SubscriptionIdParameter": {
"description": "Subscription Id which forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string",
"x-ms-parameter-location": "client"
}
},
"paths": {
"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentScripts": {
"get": {
"description": "Lists all deployment scripts for a given subscription.",
"operationId": "DeploymentScripts_ListBySubscription",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK -- Returns a list of deployment scripts.",
"schema": {
"$ref": "#/definitions/DeploymentScriptListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"tags": [
"DeploymentScripts"
],
"x-ms-examples": {
"DeploymentScriptsListBySubscription": {
"parameters": {
"api-version": "2019-10-01-preview",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"value": [
{
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {}
}
},
"kind": "AzurePowerShell",
"location": "westus",
"properties": {
"arguments": "-Location 'westus' -Name \"*rg2\"",
"azPowerShellVersion": "1.7.0",
"cleanupPreference": "Always",
"outputs": {
"output1": "value1"
},
"provisioningState": "Succeeded",
"retentionInterval": "PT7D",
"scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name",
"status": {
"containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer",
"endTime": "2018-11-13T15:19:45-08:00",
"expirationTime": "2018-11-13T15:19:45-08:00",
"startTime": "2018-11-13T15:19:45-08:00",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage"
},
"timeout": "PT1H"
}
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts": {
"get": {
"description": "Lists deployments scripts.",
"operationId": "DeploymentScripts_ListByResourceGroup",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK -- Returns a list of deployment scripts.",
"schema": {
"$ref": "#/definitions/DeploymentScriptListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"tags": [
"DeploymentScripts"
],
"x-ms-examples": {
"DeploymentScriptsList": {
"parameters": {
"api-version": "2019-10-01-preview",
"resourceGroupName": "script-rg",
"scriptName": "MyDeploymentScript",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"value": [
{
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {}
}
},
"kind": "AzurePowerShell",
"location": "westus",
"properties": {
"arguments": "-Location 'westus' -Name \"*rg2\"",
"azPowerShellVersion": "1.7.0",
"cleanupPreference": "Always",
"outputs": {
"output1": "value1"
},
"provisioningState": "Succeeded",
"retentionInterval": "P7D",
"scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name",
"status": {
"containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer",
"endTime": "2018-11-13T15:19:45-08:00",
"expirationTime": "2018-11-13T15:19:45-08:00",
"startTime": "2018-11-13T15:19:45-08:00",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage"
},
"supportingScriptUris": [
"https://uri1.to.supporting.script",
"https://uri2.to.supporting.script"
],
"timeout": "PT1H"
}
}
]
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}": {
"delete": {
"description": "Deletes a deployment script. When operation completes, status code 200 returned without content.",
"operationId": "DeploymentScripts_Delete",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ScriptNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK -- Deployment script deleted."
},
"204": {
"description": "Deployment script does not exist."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"tags": [
"DeploymentScripts"
],
"x-ms-examples": {
"DeploymentScriptsDelete": {
"parameters": {
"api-version": "2019-10-01-preview",
"deploymentScript": {
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {}
}
},
"kind": "AzurePowerShell",
"location": "westus",
"properties": {
"arguments": "user script arguments",
"azPowerShellVersion": "1.7.0",
"cleanupPreference": "Always",
"outputs": {
"output1": "value1"
},
"provisioningState": "Succeeded",
"results": {
"aciId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer",
"endTime": "2018-11-13T15:19:45-08:00",
"expirationTime": "2018-11-13T15:19:45-08:00",
"startTime": "2018-11-13T15:19:45-08:00",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage"
},
"retentionInterval": "PT7D",
"scriptContent": "user script body",
"supportingScriptUris": [
"https://uri1.to.supporting.script",
"https://uri2.to.supporting.script"
],
"timeout": "PT1H"
}
},
"resourceGroupName": "script-rg",
"scriptName": "MyDeploymentScript",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {},
"204": {}
}
}
}
},
"get": {
"description": "Gets a deployment script with a given name.",
"operationId": "DeploymentScripts_Get",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ScriptNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK -- Returns information about the deployment script.",
"schema": {
"$ref": "#/definitions/DeploymentScript"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"tags": [
"DeploymentScripts"
],
"x-ms-examples": {
"DeploymentScriptsGet": {
"parameters": {
"api-version": "2019-10-01-preview",
"resourceGroupName": "script-rg",
"scriptName": "MyDeploymentScript",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {}
}
},
"kind": "AzurePowerShell",
"location": "westus",
"properties": {
"arguments": "-Location 'westus' -Name \"*rg2\"",
"azPowerShellVersion": "1.7.0",
"cleanupPreference": "Always",
"outputs": {
"output1": "value1"
},
"provisioningState": "Succeeded",
"retentionInterval": "PT7D",
"scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name",
"status": {
"containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer",
"endTime": "2018-11-13T15:19:45-08:00",
"expirationTime": "2018-11-13T15:19:45-08:00",
"startTime": "2018-11-13T15:19:45-08:00",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage"
},
"timeout": "PT1H"
}
}
}
}
}
}
},
"patch": {
"description": "Updates deployment script tags with specified values.",
"operationId": "DeploymentScripts_Update",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ScriptNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"description": "Deployment script resource with the tags to be updated.",
"in": "body",
"name": "deploymentScript",
"schema": {
"$ref": "#/definitions/DeploymentScriptUpdateParameter"
}
}
],
"responses": {
"200": {
"description": "OK -- Deployment script tags are updated.",
"schema": {
"$ref": "#/definitions/DeploymentScript"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"tags": [
"DeploymentScripts"
],
"x-ms-examples": {
"DeploymentScriptsUpdate": {
"parameters": {
"api-version": "2019-10-01-preview",
"deploymentScript": {
"tags": {}
},
"resourceGroupName": "script-rg",
"scriptName": "MyDeploymentScript",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {}
}
},
"kind": "AzurePowerShell",
"location": "westus",
"properties": {
"arguments": "-Location 'westus' -Name \"*rg2\"",
"azPowerShellVersion": "1.7.0",
"cleanupPreference": "Always",
"outputs": {
"output1": "value1"
},
"provisioningState": "Succeeded",
"retentionInterval": "P7D",
"scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name",
"status": {
"containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer",
"endTime": "2018-11-13T15:19:45-08:00",
"expirationTime": "2018-11-13T15:19:45-08:00",
"startTime": "2018-11-13T15:19:45-08:00",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage"
},
"supportingScriptUris": [
"https://uri1.to.supporting.script",
"https://uri2.to.supporting.script"
],
"timeout": "PT1H"
},
"tags": {}
}
}
}
}
}
},
"put": {
"description": "Creates a deployment script.",
"operationId": "DeploymentScripts_Create",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ScriptNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"description": "Deployment script supplied to the operation.",
"in": "body",
"name": "deploymentScript",
"required": true,
"schema": {
"$ref": "#/definitions/DeploymentScript"
}
}
],
"responses": {
"200": {
"description": "OK -- Deployment script is updated.",
"schema": {
"$ref": "#/definitions/DeploymentScript"
}
},
"201": {
"description": "Created -- Deployment script created.",
"schema": {
"$ref": "#/definitions/DeploymentScript"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"tags": [
"DeploymentScripts"
],
"x-ms-examples": {
"DeploymentScriptsCreate": {
"parameters": {
"api-version": "2019-10-01-preview",
"deploymentScript": {
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {}
}
},
"kind": "AzurePowerShell",
"location": "westus",
"properties": {
"arguments": "-Location 'westus' -Name \"*rg2\"",
"azPowerShellVersion": "1.7.0",
"cleanupPreference": "Always",
"retentionInterval": "PT7D",
"scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name",
"supportingScriptUris": [
"https://uri1.to.supporting.script",
"https://uri2.to.supporting.script"
],
"timeout": "PT1H"
}
},
"resourceGroupName": "script-rg",
"scriptName": "MyDeploymentScript",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {}
}
},
"kind": "AzurePowerShell",
"location": "westus",
"properties": {
"arguments": "-Location 'westus' -Name \"*rg2\"",
"azPowerShellVersion": "1.7.0",
"cleanupPreference": "Always",
"outputs": {
"output1": "value1"
},
"provisioningState": "Succeeded",
"retentionInterval": "P7D",
"scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name",
"status": {
"containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer",
"endTime": "2018-11-13T15:19:45-08:00",
"expirationTime": "2018-11-13T15:19:45-08:00",
"startTime": "2018-11-13T15:19:45-08:00",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage"
},
"supportingScriptUris": [
"https://uri1.to.supporting.script",
"https://uri2.to.supporting.script"
],
"timeout": "PT1H"
}
}
},
"201": {
"body": {
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {}
}
},
"kind": "AzurePowerShell",
"location": "westus",
"properties": {
"arguments": "-Location 'westus' -Name \"*rg2\"",
"azPowerShellVersion": "1.7.0",
"cleanupPreference": "Always",
"provisioningState": "Creating",
"retentionInterval": "P7D",
"scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name",
"status": {
"containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer",
"endTime": "2018-11-13T15:19:45-08:00",
"expirationTime": "2018-11-13T15:19:45-08:00",
"startTime": "2018-11-13T15:19:45-08:00",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage"
},
"supportingScriptUris": [
"https://uri1.to.supporting.script",
"https://uri2.to.supporting.script"
],
"timeout": "PT1H"
}
}
}
}
},
"DeploymentScriptsCreate_MinCreate": {
"parameters": {
"api-version": "2019-10-01-preview",
"deploymentScript": {
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {}
}
},
"kind": "AzurePowerShell",
"location": "westus",
"properties": {
"arguments": "-Location 'westus' -Name \"*rg2\"",
"azPowerShellVersion": "1.7.0",
"retentionInterval": "P7D",
"scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name"
}
},
"resourceGroupName": "script-rg",
"scriptName": "MyDeploymentScript",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {}
}
},
"kind": "AzurePowerShell",
"location": "westus",
"properties": {
"arguments": "-Location 'westus' -Name \"*rg2\"",
"azPowerShellVersion": "1.7.0",
"cleanupPreference": "Always",
"outputs": {
"output1": "value1"
},
"provisioningState": "Succeeded",
"retentionInterval": "P7D",
"scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name",
"status": {
"containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer",
"endTime": "2018-11-13T15:19:45-08:00",
"expirationTime": "2018-11-13T15:19:45-08:00",
"startTime": "2018-11-13T15:19:45-08:00",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage"
},
"timeout": "PT1H"
}
}
},
"201": {
"body": {
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {}
}
},
"kind": "AzurePowerShell",
"location": "westus",
"properties": {
"arguments": "-Location 'westus' -Name \"*rg2\"",
"azPowerShellVersion": "1.7.0",
"cleanupPreference": "Always",
"provisioningState": "Creating",
"retentionInterval": "P7D",
"scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name",
"status": {
"containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer",
"endTime": "2018-11-13T15:19:45-08:00",
"expirationTime": "2018-11-13T15:19:45-08:00",
"startTime": "2018-11-13T15:19:45-08:00",
"storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage"
},
"timeout": "PT1H"
}
}
}
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}/logs": {
"get": {
"description": "Gets deployment script logs for a given deployment script name.",
"operationId": "DeploymentScripts_GetLogs",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ScriptNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK -- Returns deployment script logs if available.",
"schema": {
"$ref": "#/definitions/ScriptLogsList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"tags": [
"DeploymentScripts"
],
"x-ms-examples": {
"DeploymentScriptsGetLogs": {
"parameters": {
"api-version": "2019-10-01-preview",
"resourceGroupName": "script-rg",
"scriptName": "MyDeploymentScript",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"value": [
{
"properties": {
"log": "script execution stdout/stderr logs"
}
}
]
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}/logs/default": {
"get": {
"description": "Gets deployment script logs for a given deployment script name.",
"operationId": "DeploymentScripts_GetLogsDefault",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ScriptNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK -- Returns deployment script logs if available.",
"schema": {
"$ref": "#/definitions/ScriptLog"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"tags": [
"DeploymentScripts"
],
"x-ms-examples": {
"DeploymentScriptsGetLogs": {
"parameters": {
"api-version": "2019-10-01-preview",
"resourceGroupName": "script-rg",
"scriptName": "MyDeploymentScript",
"subscriptionId": "00000000-0000-0000-0000-000000000000"
},
"responses": {
"200": {
"body": {
"properties": {
"log": "script execution stdout/stderr logs"
}
}
}
}
}
}
}
}
},
"definitions": {
"AzureCliScript": {
"allOf": [
{
"$ref": "#/definitions/DeploymentScript"
}
],
"description": "Object model for the Azure CLI script.",
"properties": {
"properties": {
"$ref": "#/definitions/AzureCliScriptProperties",
"description": "Properties of the Azure CLI script object.",
"x-ms-client-flatten": true
}
},
"required": [
"properties"
],
"type": "object",
"x-ms-discriminator-value": "AzureCLI"
},
"AzureCliScriptProperties": {
"allOf": [
{
"$ref": "#/definitions/DeploymentScriptPropertiesBase"
},
{
"$ref": "#/definitions/ScriptConfigurationBase"
}
],
"description": "Properties of the Azure CLI script object.",
"properties": {
"azCliVersion": {
"description": "Azure CLI module version to be used.",
"type": "string"
}
},
"required": [
"azCliVersion"
],
"type": "object"
},
"AzurePowerShellScript": {
"allOf": [
{
"$ref": "#/definitions/DeploymentScript"
}
],
"description": "Object model for the Azure PowerShell script.",
"properties": {
"properties": {
"$ref": "#/definitions/AzurePowerShellScriptProperties",
"description": "Properties of the Azure PowerShell script object.",
"x-ms-client-flatten": true
}
},
"required": [
"properties"
],
"type": "object",
"x-ms-discriminator-value": "AzurePowerShell"
},
"AzurePowerShellScriptProperties": {
"allOf": [
{
"$ref": "#/definitions/DeploymentScriptPropertiesBase"
},
{
"$ref": "#/definitions/ScriptConfigurationBase"
}
],
"description": "Properties of the Azure PowerShell script object.",
"properties": {
"azPowerShellVersion": {
"description": "Azure PowerShell module version to be used.",
"type": "string"
}
},
"required": [
"azPowerShellVersion"
],
"type": "object"
},
"AzureResourceBase": {
"description": "Common properties for all Azure resources.",
"properties": {
"id": {
"description": "String Id used to locate any resource on Azure.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of this resource.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Type of this resource.",
"readOnly": true,
"type": "string"
}
},
"type": "object",
"x-ms-azure-resource": true
},
"DefaultErrorResponse": {
"description": "The details of the error.",
"properties": {
"code": {
"description": "One of a server-defined set of error codes.",
"type": "string"
},
"details": {
"description": "Detailed errors.",
"items": {
"$ref": "#/definitions/DefaultErrorResponse"
},
"type": "array"
},
"message": {
"description": "A human-readable representation of the error.",
"type": "string"
},
"target": {
"description": "The target of the particular error.",
"type": "string"
}
},
"type": "object"
},
"DeploymentScript": {
"allOf": [
{
"$ref": "#/definitions/AzureResourceBase"
}
],
"description": "Deployment script object.",
"discriminator": "kind",
"properties": {
"identity": {
"$ref": "#/definitions/ManagedServiceIdentity",
"description": "Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported."
},
"kind": {
"description": "Type of the script.",
"enum": [
"AzurePowerShell",
"AzureCLI"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScriptType"
}
},
"location": {
"description": "The location of the ACI and the storage account for the deployment script.",
"type": "string",
"x-ms-mutability": [
"read",
"create"
]
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags.",
"type": "object"
}
},
"required": [
"identity",
"location",
"kind"
],
"type": "object"
},
"DeploymentScriptListResult": {
"description": "List of deployment scripts.",
"properties": {
"nextLink": {
"description": "The URL to use for getting the next set of results.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "An array of deployment scripts.",
"items": {
"$ref": "#/definitions/DeploymentScript"
},
"type": "array"
}
}
},
"DeploymentScriptPropertiesBase": {
"description": "Common properties for the deployment script.",
"properties": {
"cleanupPreference": {
"description": "The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'.",
"enum": [
"Always",
"OnSuccess",
"OnExpiration"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "cleanupOptions"
}
},
"outputs": {
"additionalProperties": {
"description": "Script output in <name, value> pair.",
"type": "object"
},
"description": "List of script outputs.",
"readOnly": true,
"type": "object"
},
"provisioningState": {
"description": "State of the script execution. This only appears in the response.",
"enum": [
"Creating",
"ProvisioningResources",
"Running",
"Succeeded",
"Failed",
"Canceled"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ScriptProvisioningState"
}
},
"status": {
"$ref": "#/definitions/ScriptStatus",
"description": "Contains the results of script execution.",
"readOnly": true,
"type": "object"
}
},
"type": "object",
"x-ms-external": true
},
"DeploymentScriptUpdateParameter": {
"allOf": [
{
"$ref": "#/definitions/AzureResourceBase"
}
],
"description": "Deployment script parameters to be updated. ",
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags to be updated.",
"type": "object"
}
},
"type": "object"
},
"EnvironmentVariable": {
"description": "The environment variable to pass to the script in the container instance.",
"properties": {
"name": {
"description": "The name of the environment variable.",
"type": "string"
},
"secureValue": {
"description": "The value of the secure environment variable.",
"type": "string"
},
"value": {
"description": "The value of the environment variable.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"LogProperties": {
"description": "Script log properties.",
"properties": {
"log": {
"description": "Script execution logs in text format.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ManagedServiceIdentity": {
"description": "Managed identity generic object.",
"properties": {
"type": {
"description": "Type of the managed identity.",
"enum": [
"UserAssigned"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ManagedServiceIdentityType"
}
},
"userAssignedIdentities": {
"additionalProperties": {
"$ref": "#/definitions/UserAssignedIdentity",
"description": "User-assigned managed identity."
},
"description": "The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.",
"type": "object"
}
},
"type": "object"
},
"ScriptConfigurationBase": {
"description": "Common configuration settings for both Azure PowerShell and Azure CLI scripts.",
"properties": {
"arguments": {
"description": "Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2' ",
"type": "string"
},
"environmentVariables": {
"description": "The environment variables to pass over to the script.",
"items": {
"$ref": "#/definitions/EnvironmentVariable"
},
"type": "array"
},
"forceUpdateTag": {
"description": "Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID.",
"type": "string"
},
"primaryScriptUri": {
"description": "Uri for the script. This is the entry point for the external script.",
"type": "string"
},
"retentionInterval": {
"description": "Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. Duration is based on ISO 8601 pattern (for example P7D means one week).",
"format": "duration",
"type": "string"
},
"scriptContent": {
"description": "Script body.",
"maxLength": 32000,
"type": "string"
},
"supportingScriptUris": {
"description": "Supporting files for the external script.",
"items": {
"description": "Supporting file Uri.",
"type": "string"
},
"type": "array"
},
"timeout": {
"description": "Maximum allowed script execution time specified in ISO 8601 format. Default value is PT1H",
"format": "duration",
"type": "string"
}
},
"required": [
"retentionInterval"
],
"type": "object",
"x-ms-external": true
},
"ScriptLog": {
"allOf": [
{
"$ref": "#/definitions/AzureResourceBase"
}
],
"description": "Script execution log object.",
"properties": {
"properties": {
"$ref": "#/definitions/LogProperties",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"ScriptLogsList": {
"description": "Deployment script execution logs.",
"properties": {
"value": {
"description": "Deployment scripts logs.",
"items": {
"$ref": "#/definitions/ScriptLog"
},
"type": "array"
}
}
},
"ScriptStatus": {
"description": "Generic object modeling results of script execution.",
"properties": {
"containerInstanceId": {
"description": "ACI resource Id.",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "End time of the script execution.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"error": {
"$ref": "#/definitions/DefaultErrorResponse",
"description": "Error that is relayed from the script execution."
},
"expirationTime": {
"description": "Time the deployment script resource will expire.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Start time of the script execution.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"storageAccountId": {
"description": "Storage account resource Id.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"UserAssignedIdentity": {
"description": "User-assigned managed identity.",
"properties": {
"clientId": {
"description": "Client App Id associated with this identity.",
"type": "string"
},
"principalId": {
"description": "Azure Active Directory principal ID associated with this identity.",
"type": "string"
}
},
"type": "object"
}
}
}
|
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "test.api.amadeus.com",
"basePath": "/v3",
"info": {
"description": "Before using this API, we recommend you read our **[Authorization Guide](https://developers.amadeus.com/self-service/apis-docs/guides/authorization-262)** for more information on how to generate an access token. \n\nPlease also be aware that our test environment is based on a subset of the production for this API it may change dynamically. For your tests, use big cities like LON (London) or NYC (New-York).",
"title": "Hotel Search API",
"version": "3.0.8",
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_amadeus.com_images_en_technology_mobile-tablet_mobile-woman-office-city.jpg.transform_medium_img.jpg"
},
"x-origin": [
{
"format": "swagger",
"url": "https://raw.githubusercontent.com/amadeus4dev/amadeus-open-api-specification/main/spec/json/HotelSearch_v3_swagger_specification.json",
"version": "2.0"
}
],
"x-providerName": "amadeus.com",
"x-serviceName": "amadeus-hotel-search"
},
"consumes": [
"application/vnd.amadeus+json"
],
"produces": [
"application/vnd.amadeus+json"
],
"tags": [
{
"description": "",
"name": "shopping"
}
],
"paths": {
"/shopping/hotel-offers": {
"get": {
"deprecated": false,
"description": "",
"operationId": "getMultiHotelOffers",
"parameters": [
{
"description": "Amadeus property codes on 8 chars. Mandatory parameter for a search by predefined list of hotels.",
"in": "query",
"items": {
"type": "string"
},
"maxItems": 20,
"minItems": 1,
"name": "hotelIds",
"required": true,
"type": "array",
"uniqueItems": false,
"x-example": [
"MCLONGHM"
]
},
{
"default": 1,
"description": "Number of adult guests (1-9) per room.",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"format": "int32",
"in": "query",
"maximum": 9,
"minimum": 1,
"name": "adults",
"required": false,
"type": "integer",
"x-example": 1
},
{
"description": "Check-in date of the stay (hotel local date). Format YYYY-MM-DD. The lowest accepted value is the present date (no dates in the past). If not present, the default value will be today's date in the GMT time zone.",
"format": "date",
"in": "query",
"name": "checkInDate",
"required": false,
"type": "string",
"x-example": "2023-11-22"
},
{
"description": "Check-out date of the stay (hotel local date). Format YYYY-MM-DD. The lowest accepted value is checkInDate+1. If not present, it will default to checkInDate +1.",
"format": "date",
"in": "query",
"name": "checkOutDate",
"required": false,
"type": "string"
},
{
"description": "Code of the country of residence of the traveler expressed using ISO 3166-1 format.",
"in": "query",
"name": "countryOfResidence",
"pattern": "[A-Z]{2}",
"required": false,
"type": "string"
},
{
"default": 1,
"description": "Number of rooms requested (1-9).",
"exclusiveMaximum": false,
"exclusiveMinimum": false,
"format": "int32",
"in": "query",
"maximum": 9,
"minimum": 1,
"name": "roomQuantity",
"required": false,
"type": "integer"
},
{
"description": "Filter hotel offers by price per night interval (ex: 200-300 or -300 or 100).\nIt is mandatory to include a currency when this field is set.",
"in": "query",
"name": "priceRange",
"required": false,
"type": "string"
},
{
"description": "Use this parameter to request a specific currency. ISO currency code (http://www.iso.org/iso/home/standards/currency_codes.htm).\nIf a hotel does not support the requested currency, the prices for the hotel will be returned in the local currency of the hotel.",
"in": "query",
"name": "currency",
"pattern": "^[A-Z]{3}$",
"required": false,
"type": "string"
},
{
"default": "NONE",
"description": "Filter the response based on a specific payment type. NONE means all types (default).",
"enum": [
"GUARANTEE",
"DEPOSIT",
"NONE"
],
"in": "query",
"name": "paymentPolicy",
"required": false,
"type": "string"
},
{
"description": "Filter response based on available meals:\n * ROOM_ONLY = Room Only\n * BREAKFAST = Breakfast\n * HALF_BOARD = Diner & Breakfast (only for Aggregators)\n * FULL_BOARD = Full Board (only for Aggregators)\n * ALL_INCLUSIVE = All Inclusive (only for Aggregators)",
"enum": [
"ROOM_ONLY",
"BREAKFAST",
"HALF_BOARD",
"FULL_BOARD",
"ALL_INCLUSIVE"
],
"in": "query",
"name": "boardType",
"required": false,
"type": "string"
},
{
"description": "Show all properties (include sold out) or available only. For sold out properties, please check availability on other dates.",
"in": "query",
"name": "includeClosed",
"required": false,
"type": "boolean"
},
{
"default": true,
"description": "Used to return only the cheapest offer per hotel or all available offers.",
"in": "query",
"name": "bestRateOnly",
"required": false,
"type": "boolean"
},
{
"description": "Requested language of descriptive texts. \nExamples: FR , fr , fr-FR.\nIf a language is not available the text will be returned in english.\nISO language code (https://www.iso.org/iso-639-language-codes.html).",
"in": "query",
"name": "lang",
"pattern": "^[a-zA-Z0-9-]{2,5}$",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MultiResponse"
}
},
"400": {
"description": "Bad request:\n\n| Code | Title |\n|-----|-----|\n| 23 | PASSENGER TYPE NOT SUPPORTED |\n| 61 | INVALID CURRENCY CODE|\n| 137 | INVALID ADULTS OCCUPANCY REQUESTED|\n| 145 | DURATION PERIOD OR DATES INCORRECT|\n| 195 | SERVICE RESTRICTION|\n| 249 | INVALID RATE CODE|\n| 377 | MAX STAY DURATION IS EXCEEDED|\n| 381 | INVALID CHECK-IN DATE|\n| 382 | INVALID CHECK-OUT DATE|\n| 383 | INVALID CITY CODE|\n| 392 | INVALID HOTEL CODE|\n| 397 | INVALID NUMBER OF ADULTS|\n| 400 | INVALID PROPERTY CODE|\n| 404 | CHECK_OUT DATE MUST BE FURTHER IN THE FUTURE THAN CHECK-IN DATE|\n| 424 | NO HOTELS FOUND WHICH MATCH THIS INPUT|\n| 431 | CHECK-OUT DATE IS TOO FAR IN THE FUTURE THAN CHECK-IN DATE|\n| 424 | NO HOTELS FOUND WHICH MATCH THIS INPUT|\n| 431 | CHECK-OUT DATE IS TOO FAR IN THE FUTURE|\n| 450 | INVALID PROVIDER RESPONSE|\n| 451 | INVALID CREDENTIALS|\n| 562 | RESTRICTED ACCESS FOR THE REQUESTED RATES AND CHAINS|\n| 784 | PROVIDER TIME OUT|\n| 790 | RATE SECURITY NOT LOADED| ",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"500": {
"description": "Internal server error.",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"summary": "getMultiHotelOffers",
"tags": [
"shopping"
]
}
},
"/shopping/hotel-offers/{offerId}": {
"get": {
"deprecated": false,
"description": " ",
"operationId": "getOfferPricing",
"parameters": [
{
"description": "Unique identifier of an offer. Either the GDS booking code or the aggregator offerId with a limited lifetime.",
"in": "path",
"name": "offerId",
"pattern": "^[A-Z0-9]*$",
"required": true,
"type": "string",
"x-example": "TSXOJ6LFQ2"
},
{
"description": "Requested language of descriptive texts. \nExamples: FR , fr , fr-FR.\nIf a language is not available the text will be returned in english.\nISO language code (https://www.iso.org/iso-639-language-codes.html).",
"in": "query",
"name": "lang",
"pattern": "^[a-zA-Z0-9-]{2,5}$",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PricingResponse"
}
},
"400": {
"description": "Bad Request:\ncode| title\n------- | -------------------------------------\n23 | PASSENGER TYPE NOT SUPPORTED\n61 |INVALID CURRENCY CODE\n137 | INVALID ADULTS OCCUPANCY REQUESTED\n145 | DURATION PERIOD OR DATES INCORRECT\n195 | SERVICE RESTRICTION\n249 | INVALID RATE CODE\n377 | MAX STAY DURATION IS EXCEEDED\n381 | INVALID CHECK-IN DATE\n382 | INVALID CHECK-OUT DATE\n383 | INVALID CITY CODE\n392 | INVALID HOTEL CODE\n397 | INVALID NUMBER OF ADULTS\n400 | INVALID PROPERTY CODE\n402 | INVALID ROOM TYPE\n404 | CHECK_OUT DATE MUST BE FURTHER IN THE FUTURE THAN CHECK-IN DATE\n424 | NO HOTELS FOUND WHICH MATCH THIS INPUT\n431 | CHECK-OUT DATE IS TOO FAR IN THE FUTURE\n450 | INVALID PROVIDER RESPONSE\n451 | INVALID CREDENTIAL\n562 | RESTRICTED ACCESS FOR THE REQUESTED RATES AND CHAINS\n784 | PROVIDER TIME OUT\n790 | NO PROPERTIES FOUND WITHIN THIS RADIUS\n795 | NO SIMILAR NAME FOUND, PLEASE ENLARGE YOUR SEARCH CRITERIA\n842 | RATE SECURITY NOT LOADED",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"404": {
"description": "Hotel or offer not found",
"schema": {
"$ref": "#/definitions/Errors"
}
},
"500": {
"description": "Internal server error.",
"schema": {
"$ref": "#/definitions/Errors"
}
}
},
"summary": "getOfferPricing",
"tags": [
"shopping"
]
}
}
},
"definitions": {
"BoardType": {
"description": "The included Breakfast/Meals",
"enum": [
"ROOM_ONLY",
"BREAKFAST",
"HALF_BOARD",
"FULL_BOARD",
"ALL_INCLUSIVE",
"BUFFET_BREAKFAST",
"CARIBBEAN_BREAKFAST",
"CONTINENTAL_BREAKFAST",
"ENGLISH_BREAKFAST",
"FULL_BREAKFAST",
"DINNER_BED_AND_BREAKFAST",
"LUNCH",
"DINNER",
"FAMILY_PLAN",
"AS_BROCHURED",
"SELF_CATERING",
"BERMUDA",
"AMERICAN",
"FAMILY_AMERICAN",
"MODIFIED"
],
"title": "BoardType",
"type": "string"
},
"CancellationType": {
"description": "* FULL_STAY: the Penalty amount equals the `total` price.",
"enum": [
"FULL_STAY"
],
"title": "CancellationType",
"type": "string"
},
"Error": {
"description": "The Error Definition",
"properties": {
"code": {
"description": "A machine-readable error code from the Amadeus Canned Messages table, that will enable the API Consumers code to handle this type of error",
"format": "int32",
"type": "integer"
},
"detail": {
"description": "An easy-to-read explanation specific to this occurrence of the problem. It should give the API consumer an idea of what went wrong and how to recover from it. Like the title, this field’s value can be localized.",
"type": "string"
},
"documentation": {
"description": "A link to a web page or file with further documentation to help the API consumer resolve this error",
"type": "string"
},
"source": {
"$ref": "#/definitions/Error_Source"
},
"status": {
"description": "The [HTTP status code](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) of this response. This is present only in terminal errors which cause an unsuccessful response. In the case of multiple errors, they must all have the same status.",
"format": "int32",
"type": "integer"
},
"title": {
"description": "An error title from the Canned Messages table with a 1:1 correspondence to the error code. This may be localized",
"type": "string"
}
},
"title": "Error",
"type": "object"
},
"Error_Source": {
"properties": {
"example": {
"description": "A sample input to guide the user when resolving this issue",
"type": "string"
},
"parameter": {
"description": "The key of the URI path or query parameter that caused the error",
"type": "string"
},
"pointer": {
"description": "A JSON Pointer [RFC6901] to the associated entity in the request body that caused this error",
"type": "string"
}
},
"title": "Error_Source",
"type": "object"
},
"Errors": {
"description": "A set of errors",
"properties": {
"errors": {
"items": {
"$ref": "#/definitions/Error"
},
"type": "array"
}
},
"title": "Errors",
"type": "object"
},
"Hotel": {
"description": "Hotel Content",
"properties": {
"brandCode": {
"description": "Brand (RT...) (Amadeus 2 chars Code). Small Properties distributed by Merchants may not have a Brand.\nExample - AD (Value Hotels) is the Provider/Merchant, and RT (Accor) is the Brand of the Property",
"example": "RT",
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"chainCode": {
"description": "Brand (RT...) or Merchant (AD...) (Amadeus 2 chars Code)",
"example": "AD",
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"cityCode": {
"description": "Warning: The IATA city code associated to the hotel (not necessary the real Hotel City)",
"example": "PAR",
"pattern": "^[A-Z]{3}$",
"type": "string"
},
"dupeId": {
"description": "Unique Property identifier of the physical hotel.\nOne physical hotel can be represented by different Providers, each one having its own `hotelID`.\nThis attribute allows a client application to group together hotels that are actually the same.",
"example": "501132260",
"type": "string"
},
"hotelId": {
"description": "Amadeus Property Code (8 chars)",
"example": "ADPAR001",
"pattern": "^[A-Z0-9]{8}$",
"type": "string"
},
"name": {
"description": "Hotel Name",
"example": "Hotel de Paris",
"type": "string"
}
},
"title": "Hotel",
"type": "object"
},
"HotelOffer": {
"description": "Hotel Offer",
"properties": {
"boardType": {
"$ref": "#/definitions/BoardType"
},
"category": {
"description": "Special Rate Category\nExamples:\n ASSOCIATION\n FAMILY_PLAN",
"example": "FAMILY_PLAN",
"type": "string"
},
"checkInDate": {
"description": "check-in date of the stay (hotel local date). Format YYYY-MM-DD\nThe lowest accepted value is today date (no dates in the past).",
"example": "2020-12-30",
"format": "date",
"type": "string"
},
"checkOutDate": {
"description": "check-out date of the stay (hotel local date). Format YYYY-MM-DD\nThe lowest accepted value is `checkInDate`+1.",
"example": "2020-12-31",
"format": "date",
"type": "string"
},
"commission": {
"$ref": "#/definitions/HotelProduct_Commission"
},
"description": {
"$ref": "#/definitions/QualifiedFreeText"
},
"guests": {
"$ref": "#/definitions/HotelProduct_Guests"
},
"id": {
"description": "Unique identifier of this offer. Might be valid for a temporary period only.",
"example": "TSXOJ6LFQ2",
"maxLength": 100,
"minLength": 2,
"pattern": "^[A-Z0-9]*$",
"type": "string"
},
"policies": {
"$ref": "#/definitions/HotelProduct_PolicyDetails"
},
"price": {
"$ref": "#/definitions/HotelProduct_HotelPrice"
},
"rateCode": {
"description": "Special Rate - Provider Response Code (3 chars)\nExamples\n\n * RAC - Rack\n\n * BAR - Best Available Rate\n\n * PRO - Promotional\n\n * COR - Corporate\n\n * GOV - Government (qualified)\n\n * AAA - AAA (qualified)\n\n * BNB - Bed and Breakfast\n\n * PKG - Package\n\n * TVL - Travel Industry\n\n * SPC - Special Promo Rate\n\n * WKD - Weekend\n\n * CON - Convention\n\n * SNR - Senior (Europe) (qualified)\n\n * ARP - AARP - American Association of Retired People (50+) (qualified)\n\n * SRS - Senior (qualified)\n\n * ROR - Room Only Rate (no breakfast)\n\n * FAM - Family\n\n * DAY - Day rate",
"example": "RAC",
"maxLength": 3,
"minLength": 3,
"pattern": "^[A-Z0-9*]{3}$",
"type": "string"
},
"rateFamilyEstimated": {
"$ref": "#/definitions/HotelProduct_RateFamily"
},
"room": {
"$ref": "#/definitions/HotelProduct_RoomDetails"
},
"roomQuantity": {
"description": "number of rooms (1-9)",
"example": "1",
"type": "string"
},
"self": {
"description": "A self link to the object. Use this to refresh the Offer price",
"example": "https://test.travel.api.amadeus.com/v2/shopping/hotel-offers/63A93695B58821ABB0EC2B33FE9FAB24D72BF34B1BD7D707293763D8D9378FC3",
"type": "string"
},
"type": {
"$ref": "#/definitions/Type"
}
},
"required": [
"id",
"rateCode",
"room",
"price"
],
"title": "HotelOffer",
"type": "object"
},
"HotelOffers": {
"properties": {
"available": {
"type": "boolean"
},
"hotel": {
"$ref": "#/definitions/Hotel"
},
"offers": {
"items": {
"$ref": "#/definitions/HotelOffer"
},
"type": "array"
},
"self": {
"type": "string"
},
"type": {
"description": "the type of the object (hotel-offers)",
"type": "string"
}
},
"title": "HotelOffers",
"type": "object"
},
"HotelProduct_CancellationPolicy": {
"properties": {
"amount": {
"description": "Amount of the cancellation fee.",
"pattern": "^\\\\d+(\\\\.\\\\d+)?$",
"type": "string"
},
"deadline": {
"description": "Represents the deadline after which the penalty applies. DateTime is in ISO 8601 [https://www.w3.org/TR/NOTE-datetime].\nExample: 2010-08-14T12:00:00+01:00\nExample: 2010-08-14T12:00:00Z\nExample: 2010-08-14T12:00:00-01:00\nThe value is expressed in the hotel local time zone, with the added time zone difference. So you can compute the deadline in UTC(GMT) if desired.",
"format": "date-time",
"type": "string"
},
"description": {
"$ref": "#/definitions/QualifiedFreeText"
},
"numberOfNights": {
"description": "Number of nights due as fee in case of cancellation.",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"percentage": {
"description": "Percentage of the total stay amount to be paid in case of cancellation. Value is between 0 and 100.",
"pattern": "^\\\\d+(\\\\.\\\\d+)?$",
"type": "string"
},
"type": {
"$ref": "#/definitions/CancellationType"
}
},
"title": "HotelProduct_CancellationPolicy",
"type": "object"
},
"HotelProduct_CheckInOutPolicy": {
"properties": {
"checkIn": {
"description": "Check-in From time limit in ISO-8601 format [http://www.w3.org/TR/xmlschema-2/#time]",
"example": "13:00:00",
"type": "string"
},
"checkInDescription": {
"$ref": "#/definitions/QualifiedFreeText"
},
"checkOut": {
"description": "Check-out Until time limit in ISO-8601 format [http://www.w3.org/TR/xmlschema-2/#time]",
"example": "11:00:00",
"type": "string"
},
"checkOutDescription": {
"$ref": "#/definitions/QualifiedFreeText"
}
},
"title": "HotelProduct_CheckInOutPolicy",
"type": "object"
},
"HotelProduct_Commission": {
"properties": {
"amount": {
"description": "Amount of the commission paid to the travel seller. The amount is always linked to the currency code of the offer",
"pattern": "^\\\\d+(\\\\.\\\\d+)?$",
"type": "string"
},
"description": {
"$ref": "#/definitions/QualifiedFreeText"
},
"percentage": {
"description": "Percentage of the commission paid to the travel seller. Value is between 0 and 100",
"pattern": "^\\\\d+(\\\\.\\\\d+)?$",
"type": "string"
}
},
"title": "HotelProduct_Commission",
"type": "object"
},
"HotelProduct_DepositPolicy": {
"description": "the deposit/prepay policy information applicable to the offer. It includes accepted payments, deadline and the amount due",
"properties": {
"acceptedPayments": {
"$ref": "#/definitions/HotelProduct_PaymentPolicy"
},
"amount": {
"description": "Deposit-Prepay amount",
"pattern": "^\\\\d+(\\\\.\\\\d+)?$",
"type": "string"
},
"deadline": {
"description": "The date and time of the deadline in ISO 8601[https://www.w3.org/TR/NOTE-datetime]. \n Example: 2010-08-14T13:00:00\n Please note that this value is expressed in the hotels local time zone",
"format": "date-time",
"type": "string"
},
"description": {
"$ref": "#/definitions/QualifiedFreeText"
}
},
"title": "HotelProduct_DepositPolicy",
"type": "object"
},
"HotelProduct_EstimatedRoomType": {
"description": "estimated room category, bed type and number of beds in the room. This information has been parsed from the room description, and is thus only provided for informational purposes",
"properties": {
"bedType": {
"description": "Type of the bed",
"type": "string"
},
"beds": {
"description": "Number of beds in the room (1-9)",
"format": "int32",
"type": "integer"
},
"category": {
"description": "Category code",
"type": "string"
}
},
"title": "HotelProduct_EstimatedRoomType",
"type": "object"
},
"HotelProduct_GuaranteePolicy": {
"description": "the guarantee policy information applicable to the offer. It includes accepted payments",
"properties": {
"acceptedPayments": {
"$ref": "#/definitions/HotelProduct_PaymentPolicy"
},
"description": {
"$ref": "#/definitions/QualifiedFreeText"
}
},
"title": "HotelProduct_GuaranteePolicy",
"type": "object"
},
"HotelProduct_Guests": {
"properties": {
"adults": {
"description": "number of adult guests (1-9) per room",
"example": 2,
"format": "int32",
"maximum": 9,
"minimum": 1,
"type": "integer"
},
"childAges": {
"description": "Comma separated list of ages of each child at the time of check-out from the hotel. If several children have the same age, the ages will be repeated.",
"items": {
"format": "int32",
"maximum": 20,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"title": "HotelProduct_Guests",
"type": "object"
},
"HotelProduct_HoldPolicy": {
"description": "the hold policy",
"properties": {
"deadline": {
"description": "The date and time of the deadline in ISO 8601[https://www.w3.org/TR/NOTE-datetime]. \n Example: 2010-08-14T13:00:00\n Please note that this value is expressed in the hotels local time zone",
"format": "date-time",
"type": "string"
}
},
"required": [
"deadline"
],
"title": "HotelProduct_HoldPolicy",
"type": "object"
},
"HotelProduct_HotelPrice": {
"description": "price information",
"properties": {
"base": {
"type": "string"
},
"currency": {
"description": "currency Code apply to all elements of the price",
"type": "string"
},
"markups": {
"items": {
"$ref": "#/definitions/Markup"
},
"type": "array"
},
"sellingTotal": {
"description": "sellingTotal = Total + margins + markup + totalFees - discounts",
"type": "string"
},
"taxes": {
"items": {
"$ref": "#/definitions/Tax"
},
"type": "array"
},
"total": {
"description": "total = base + totalTaxes",
"type": "string"
},
"variations": {
"$ref": "#/definitions/HotelProduct_PriceVariations"
}
},
"title": "HotelProduct_HotelPrice",
"type": "object"
},
"HotelProduct_PaymentPolicy": {
"description": "Accepted Payment Methods and Card Types. Several Payment Methods and Card Types may be available.",
"properties": {
"creditCards": {
"description": "Accepted Payment Card Types for the `method` CREDIT_CARD",
"items": {
"maxLength": 2,
"minLength": 2,
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"maxLength": 2,
"minLength": 2,
"pattern": "^[A-Z]{2}$",
"type": "array"
},
"methods": {
"description": "Accepted Payment Methods",
"items": {
"$ref": "#/definitions/Method"
},
"type": "array"
}
},
"title": "HotelProduct_PaymentPolicy",
"type": "object"
},
"HotelProduct_PolicyDetails": {
"description": "Booking Rules",
"properties": {
"cancellation": {
"$ref": "#/definitions/HotelProduct_CancellationPolicy"
},
"checkInOut": {
"$ref": "#/definitions/HotelProduct_CheckInOutPolicy"
},
"deposit": {
"$ref": "#/definitions/HotelProduct_DepositPolicy"
},
"guarantee": {
"$ref": "#/definitions/HotelProduct_GuaranteePolicy"
},
"holdTime": {
"$ref": "#/definitions/HotelProduct_HoldPolicy"
},
"paymentType": {
"$ref": "#/definitions/PaymentType"
},
"prepay": {
"$ref": "#/definitions/HotelProduct_DepositPolicy"
}
},
"title": "HotelProduct_PolicyDetails",
"type": "object"
},
"HotelProduct_PriceVariation": {
"description": "Some prices may vary during a stay, thus here you can see the daily price per period of the stay",
"properties": {
"base": {
"type": "string"
},
"currency": {
"description": "currency Code apply to all elements of the price",
"type": "string"
},
"endDate": {
"description": "End date of the period\nFormat: YYYY-MM-DD",
"format": "date",
"type": "string"
},
"markups": {
"items": {
"$ref": "#/definitions/Markup"
},
"type": "array"
},
"sellingTotal": {
"description": "sellingTotal = Total + margins + markup + totalFees - discounts",
"type": "string"
},
"startDate": {
"description": "Begin date of the period\nFormat: YYYY-MM-DD",
"format": "date",
"type": "string"
},
"total": {
"description": "total = base + totalTaxes",
"type": "string"
}
},
"required": [
"startDate",
"endDate"
],
"title": "HotelProduct_PriceVariation",
"type": "object"
},
"HotelProduct_PriceVariations": {
"description": "Daily price variations and the average daily price (when available) is shown here",
"properties": {
"average": {
"$ref": "#/definitions/Price"
},
"changes": {
"description": "A collection of price periods if the daily price changes during the stay",
"items": {
"$ref": "#/definitions/HotelProduct_PriceVariation"
},
"type": "array"
}
},
"title": "HotelProduct_PriceVariations",
"type": "object"
},
"HotelProduct_RateFamily": {
"description": "The estimated rate code family of the offer. Grouping various rate plan codes that belongs to the same family and indicates the type of the rate",
"properties": {
"code": {
"description": "The estimated rate family (PRO,FAM,GOV)",
"pattern": "[A-Z0-9]{3}",
"type": "string"
},
"type": {
"description": "The type of the rate (public=P, negotiated=N, conditional=C)",
"pattern": "[PNC]",
"type": "string"
}
},
"title": "HotelProduct_RateFamily",
"type": "object"
},
"HotelProduct_RoomDetails": {
"properties": {
"description": {
"$ref": "#/definitions/QualifiedFreeText"
},
"type": {
"description": "Room type code, 3 character identifier of the room.\nThe first character identifies the room type category. \nThe second numeric character identifies the number of beds. \nThe third character identifies the bed type. \nThere is a special case where ROH is returned, this value stands for Run Of House.",
"pattern": "^[A-Z0-9*]{3}$",
"type": "string"
},
"typeEstimated": {
"$ref": "#/definitions/HotelProduct_EstimatedRoomType"
}
},
"title": "HotelProduct_RoomDetails",
"type": "object"
},
"Markup": {
"description": "Markup applied to provide a service or a product to the client. The markup can be introduced by any stakeholder. Typical use case is to convey markup information set by the travel agent or in case of merchant mode.",
"properties": {
"amount": {
"description": "Defines the monetary value with decimal position as a String.",
"example": "10",
"type": "string"
}
},
"title": "Markup",
"type": "object"
},
"Method": {
"description": "The Payment Methods\n * CREDIT_CARD (CC) - Payment Cards in `creditCards` are accepted\n * AGENCY_ACCOUNT - Agency Account (Credit Line) is accepted. Agency is Charged at CheckOut\n * TRAVEL_AGENT_ID - Agency IATA/ARC Number is accepted to Guarantee the booking\n * CORPORATE_ID (COR-ID) - Corporate Account is accepted to Guarantee the booking\n * HOTEL_GUEST_ID - Hotel Chain Rewards Card Number is accepted to Guarantee the booking\n * CHECK - Checks are accepted\n * MISC_CHARGE_ORDER - Miscellaneous Charge Order is accepted\n * ADVANCE_DEPOSIT - Cash is accepted for Deposit/PrePay\n * COMPANY_ADDRESS - Company Billing Address is accepted to Guarantee the booking",
"enum": [
"CREDIT_CARD",
"AGENCY_ACCOUNT",
"TRAVEL_AGENT_ID",
"CORPORATE_ID",
"HOTEL_GUEST_ID",
"CHECK",
"MISC_CHARGE_ORDER",
"ADVANCE_DEPOSIT",
"COMPANY_ADDRESS",
"VCC_BILLBACK",
"VCC_B2B_WALLET",
"DEFERED_PAYMENT",
"TRAVEL_AGENT_IMMEDIATE"
],
"title": "Method",
"type": "string"
},
"MultiResponse": {
"example": {
"data": [
{
"available": true,
"hotel": {
"chainCode": "MC",
"cityCode": "LON",
"dupeId": "700031300",
"hotelId": "MCLONGHM",
"latitude": 51.50988,
"longitude": -0.15509,
"name": "JW Marriott Grosvenor House London",
"type": "hotel"
},
"offers": [
{
"checkInDate": "2023-11-22",
"checkOutDate": "2023-11-23",
"guests": {
"adults": 1
},
"id": "TSXOJ6LFQ2",
"policies": {
"cancellation": {
"description": {
"text": "NON-REFUNDABLE RATE"
},
"type": "FULL_STAY"
},
"paymentType": "deposit"
},
"price": {
"base": "716.00",
"currency": "GBP",
"total": "716.00",
"variations": {
"average": {
"base": "716.00"
},
"changes": [
{
"endDate": "2023-11-23",
"startDate": "2023-11-22",
"total": "716.00"
}
]
}
},
"rateCode": "V ",
"rateFamilyEstimated": {
"code": "PRO",
"type": "P"
},
"room": {
"description": {
"lang": "EN",
"text": "Prepay Non-refundable Non-changeable, prepay in full\nExecutive King Room, Executive Lounge Access,\n1 King, 35sqm/377sqft-40sqm/430sqft, Wireless"
},
"type": "ELE",
"typeEstimated": {
"bedType": "DOUBLE",
"beds": 1,
"category": "EXECUTIVE_ROOM"
}
},
"self": "https://test.api.amadeus.com/v3/shopping/hotel-offers/TSXOJ6LFQ2"
}
],
"self": "https://test.api.amadeus.com/v3/shopping/hotel-offers?hotelIds=MCLONGHM&adults=1&checkInDate=2023-11-22&paymentPolicy=NONE&roomQuantity=1",
"type": "hotel-offers"
}
]
},
"properties": {
"data": {
"$ref": "#/definitions/HotelOffers"
}
},
"title": "MultiResponse",
"type": "object"
},
"PaymentType": {
"description": "payment type. Guarantee means Pay at Check Out. Check the `methods` in `guarantee` or `deposit` or `prepay`.",
"enum": [
"GUARANTEE",
"DEPOSIT",
"PREPAY",
"HOLDTIME"
],
"title": "PaymentType",
"type": "string"
},
"Price": {
"description": "Price valuation information",
"properties": {
"base": {
"type": "string"
},
"currency": {
"description": "currency Code apply to all elements of the price",
"type": "string"
},
"markups": {
"items": {
"$ref": "#/definitions/Markup"
},
"type": "array"
},
"sellingTotal": {
"description": "sellingTotal = Total + margins + markup + totalFees - discounts",
"type": "string"
},
"total": {
"description": "total = base + totalTaxes",
"type": "string"
}
},
"title": "Price",
"type": "object"
},
"PricingResponse": {
"example": {
"data": {
"available": true,
"hotel": {
"address": {
"countryCode": "GB"
},
"amenities": [
"CRIBS_AVAILABLE"
],
"chainCode": "MC",
"cityCode": "LON",
"hotelId": "MCLONGHM",
"name": "JW MARRIOTT GROSVENOR HOUSE",
"type": "hotel"
},
"offers": [
{
"checkInDate": "2023-11-22",
"checkOutDate": "2023-11-23",
"description": {
"lang": "EN",
"text": "Executive King Room, Executive Lounge Access, 1 King, 35sqm/377sqft-40sqm/430sqft, Wireless in ternet, for a fee, Wired internet, for a fee, C A credit card is required for payment to guarantee the Prepay Non-refundable Non-changeable rate. Prepay rates will be charged the full cost of the reservation within 24 hours of making the reservation. If payment is unsuccessful within 48 hours of making the reservation, the hotel reserves the right to cancel the reservation. Date changes to the reservation are not allowed. Cancellation will result in forfeiture of the prepayment. The credit card used at the time of making the reservation must be valid for the entire stay."
},
"guests": {
"adults": 1
},
"id": "TSXOJ6LFQ2",
"policies": {
"cancellation": {
"description": {
"text": "NON-REFUNDABLE RATE"
},
"type": "FULL_STAY"
},
"paymentType": "deposit"
},
"price": {
"base": "716.00",
"currency": "GBP",
"total": "716.00",
"variations": {
"changes": [
{
"base": "716.00",
"endDate": "2023-11-23",
"startDate": "2023-11-22"
}
]
}
},
"rateCode": "V ",
"rateFamilyEstimated": {
"code": "PRO",
"type": "P"
},
"room": {
"description": {
"lang": "EN",
"text": "Prepay Non-refundable Non-changeable, prepay in full"
},
"type": "ELE",
"typeEstimated": {
"bedType": "DOUBLE",
"beds": 1
}
}
}
],
"type": "hotel-offers"
},
"meta": {
"lang": "EN"
}
},
"properties": {
"data": {
"$ref": "#/definitions/HotelOffers"
}
},
"title": "PricingResponse",
"type": "object"
},
"QualifiedFreeText": {
"description": "Specific type to convey a list of string for specific information type ( via qualifier) in specific character set, or language",
"properties": {
"lang": {
"description": "see RFC 5646",
"example": "fr-FR",
"type": "string"
},
"text": {
"description": "Free Text",
"example": "A description",
"type": "string"
}
},
"title": "QualifiedFreeText",
"type": "object"
},
"Tax": {
"description": "IATA Tax definition: An impost for raising revenue for the general treasury and which will be used for general public purposes.",
"properties": {
"amount": {
"description": "Defines amount with decimal separator.",
"type": "string"
},
"code": {
"description": "International Standards Organization (ISO) Tax code.It is a two-letter country code.",
"type": "string"
},
"currency": {
"description": "Defines a monetary unit. It is a three alpha code (iata code). Example: EUR for Euros, USD for US dollar, etc.",
"maxLength": 3,
"minLength": 1,
"type": "string"
},
"description": {
"description": "Example - \"Governement tax\"",
"type": "string"
},
"included": {
"description": "Indicates if tax is included or not",
"type": "boolean"
},
"percentage": {
"description": "In the case of a tax on TST value, the percentage of the tax will be indicated in this field.",
"type": "string"
},
"pricingFrequency": {
"description": "Specifies if the tax applies per stay or per night\n - PER_STAY\n - PER_NIGHT",
"type": "string"
},
"pricingMode": {
"description": "Specifies if the tax applies per occupant or per room\n - PER_OCCUPANT\n - PER_PRODUCT",
"type": "string"
}
},
"title": "Tax",
"type": "object"
},
"Type": {
"description": "data type",
"enum": [
"hotel-offer"
],
"title": "Type",
"type": "string"
}
}
}
|
"{\n \"openapi\": \"3.0.1\",\n \"servers\": [\n {\n \"url\": \"https://notify.twilio.com\"(...TRUNCATED)
|
"{\n \"openapi\": \"3.0.1\",\n \"servers\": [\n {\n \"url\": \"https://your-domain.atlassi(...TRUNCATED)
|
"{\n \"openapi\": \"3.0.0\",\n \"info\": {\n \"version\": \"2016-02-06\",\n \"x-release\": \(...TRUNCATED)
|
"{\n \"openapi\": \"3.0.0\",\n \"info\": {\n \"version\": \"2017-01-06\",\n \"x-release\": \(...TRUNCATED)
|
"{\n \"swagger\": \"2.0\",\n \"schemes\": [\n \"https\"\n ],\n \"host\": \"developer.o2.cz\",(...TRUNCATED)
|
"{\n \"swagger\": \"2.0\",\n \"schemes\": [\n \"https\"\n ],\n \"host\": \"management.azure.c(...TRUNCATED)
|
End of preview. Expand
in Data Studio
- Downloads last month
- 6