Package-level declarations

Types

Link copied to clipboard
data class ActionOnUnmanageResponse(val managementGroups: String? = null, val resourceGroups: String? = null, val resources: String)

Defines the behavior of resources that are no longer managed after the stack is updated or deleted.

Link copied to clipboard
data class AliasPathMetadataResponse(val attributes: String, val type: String)
Link copied to clipboard
data class AliasPathResponse(val apiVersions: List<String>? = null, val metadata: AliasPathMetadataResponse, val path: String? = null, val pattern: AliasPatternResponse? = null)

The type of the paths for alias.

Link copied to clipboard
data class AliasPatternResponse(val phrase: String? = null, val type: String? = null, val variable: String? = null)

The type of the pattern for an alias path.

Link copied to clipboard
data class AliasResponse(val defaultMetadata: AliasPathMetadataResponse, val defaultPath: String? = null, val defaultPattern: AliasPatternResponse? = null, val name: String? = null, val paths: List<AliasPathResponse>? = null, val type: String? = null)

The alias type.

Link copied to clipboard
data class ApiProfileResponse(val apiVersion: String, val profileVersion: String)
Link copied to clipboard
data class BasicDependencyResponse(val id: String? = null, val resourceName: String? = null, val resourceType: String? = null)

Deployment dependency information.

Link copied to clipboard
data class ContainerConfigurationResponse(val containerGroupName: String? = null, val subnetIds: List<ContainerGroupSubnetIdResponse>? = null)

Settings to customize ACI container instance.

Link copied to clipboard
data class ContainerGroupSubnetIdResponse(val id: String, val name: String? = null)

Container group subnet information.

Link copied to clipboard
data class DebugSettingResponse(val detailLevel: String? = null)

The debug setting.

Link copied to clipboard
data class DenySettingsResponse(val applyToChildScopes: Boolean? = null, val excludedActions: List<String>? = null, val excludedPrincipals: List<String>? = null, val mode: String)

Defines how resources deployed by the Deployment stack are locked.

Link copied to clipboard
data class DependencyResponse(val dependsOn: List<BasicDependencyResponse>? = null, val id: String? = null, val resourceName: String? = null, val resourceType: String? = null)

Deployment dependency information.

Link copied to clipboard
data class DeploymentParameterResponse(val reference: KeyVaultParameterReferenceResponse? = null, val type: String? = null, val value: Any? = null)

Deployment parameter for the template.

Link copied to clipboard
data class DeploymentPropertiesExtendedResponse(val correlationId: String, val debugSetting: DebugSettingResponse, val dependencies: List<DependencyResponse>, val duration: String, val error: ErrorResponseResponse, val mode: String, val onErrorDeployment: OnErrorDeploymentExtendedResponse, val outputResources: List<ResourceReferenceResponse>, val outputs: Any, val parameters: Any, val parametersLink: ParametersLinkResponse, val providers: List<ProviderResponse>, val provisioningState: String, val templateHash: String, val templateLink: TemplateLinkResponse, val timestamp: String, val validatedResources: List<ResourceReferenceResponse>)

Deployment properties with additional details.

Link copied to clipboard
data class DeploymentStacksDebugSettingResponse(val detailLevel: String? = null)

The debug setting.

Link copied to clipboard
data class DeploymentStacksParametersLinkResponse(val contentVersion: String? = null, val uri: String)

Entity representing the reference to the deployment parameters.

Link copied to clipboard
data class EnvironmentVariableResponse(val name: String, val secureValue: String? = null, val value: String? = null)

The environment variable to pass to the script in the container instance.

Link copied to clipboard
data class ErrorAdditionalInfoResponse(val info: Any, val type: String)

The resource management error additional info.

Link copied to clipboard
data class ErrorDetailResponse(val additionalInfo: List<ErrorAdditionalInfoResponse>, val code: String, val details: List<ErrorDetailResponse>, val message: String, val target: String)

The error detail.

Link copied to clipboard
data class ErrorResponseResponse(val additionalInfo: List<ErrorAdditionalInfoResponse>, val code: String, val details: List<ErrorResponseResponse>, val message: String, val target: String)

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

Link copied to clipboard
data class ExtendedLocationResponse(val name: String? = null, val type: String? = null)

Resource extended location.

Link copied to clipboard
data class GetAzureCliScriptResult(val arguments: String? = null, val azCliVersion: String, val azureApiVersion: String, val cleanupPreference: String? = null, val containerSettings: ContainerConfigurationResponse? = null, val environmentVariables: List<EnvironmentVariableResponse>? = null, val forceUpdateTag: String? = null, val id: String, val identity: ManagedServiceIdentityResponse? = null, val kind: String, val location: String, val name: String, val outputs: Map<String, Any>, val primaryScriptUri: String? = null, val provisioningState: String, val retentionInterval: String, val scriptContent: String? = null, val status: ScriptStatusResponse, val storageAccountSettings: StorageAccountConfigurationResponse? = null, val supportingScriptUris: List<String>? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val timeout: String? = null, val type: String)

Object model for the Azure CLI script.

Link copied to clipboard
data class GetAzurePowerShellScriptResult(val arguments: String? = null, val azPowerShellVersion: String, val azureApiVersion: String, val cleanupPreference: String? = null, val containerSettings: ContainerConfigurationResponse? = null, val environmentVariables: List<EnvironmentVariableResponse>? = null, val forceUpdateTag: String? = null, val id: String, val identity: ManagedServiceIdentityResponse? = null, val kind: String, val location: String, val name: String, val outputs: Map<String, Any>, val primaryScriptUri: String? = null, val provisioningState: String, val retentionInterval: String, val scriptContent: String? = null, val status: ScriptStatusResponse, val storageAccountSettings: StorageAccountConfigurationResponse? = null, val supportingScriptUris: List<String>? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val timeout: String? = null, val type: String)

Object model for the Azure PowerShell script.

data class GetDeploymentAtManagementGroupScopeResult(val azureApiVersion: String, val id: String, val location: String? = null, val name: String, val properties: DeploymentPropertiesExtendedResponse, val tags: Map<String, String>? = null, val type: String)

Deployment information.

Link copied to clipboard
data class GetDeploymentAtScopeResult(val azureApiVersion: String, val id: String, val location: String? = null, val name: String, val properties: DeploymentPropertiesExtendedResponse, val tags: Map<String, String>? = null, val type: String)

Deployment information.

Link copied to clipboard
data class GetDeploymentAtSubscriptionScopeResult(val azureApiVersion: String, val id: String, val location: String? = null, val name: String, val properties: DeploymentPropertiesExtendedResponse, val tags: Map<String, String>? = null, val type: String)

Deployment information.

Link copied to clipboard
data class GetDeploymentAtTenantScopeResult(val azureApiVersion: String, val id: String, val location: String? = null, val name: String, val properties: DeploymentPropertiesExtendedResponse, val tags: Map<String, String>? = null, val type: String)

Deployment information.

Link copied to clipboard
data class GetDeploymentResult(val azureApiVersion: String, val id: String, val location: String? = null, val name: String, val properties: DeploymentPropertiesExtendedResponse, val tags: Map<String, String>? = null, val type: String)

Deployment information.

data class GetDeploymentStackAtManagementGroupResult(val actionOnUnmanage: ActionOnUnmanageResponse, val azureApiVersion: String, val correlationId: String, val debugSetting: DeploymentStacksDebugSettingResponse? = null, val deletedResources: List<ResourceReferenceResponse>, val denySettings: DenySettingsResponse, val deploymentId: String, val deploymentScope: String? = null, val description: String? = null, val detachedResources: List<ResourceReferenceResponse>, val duration: String, val error: ErrorDetailResponse? = null, val failedResources: List<ResourceReferenceExtendedResponse>, val id: String, val location: String? = null, val name: String, val outputs: Any, val parameters: Map<String, DeploymentParameterResponse>? = null, val parametersLink: DeploymentStacksParametersLinkResponse? = null, val provisioningState: String, val resources: List<ManagedResourceReferenceResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Deployment stack object.

Link copied to clipboard
data class GetDeploymentStackAtResourceGroupResult(val actionOnUnmanage: ActionOnUnmanageResponse, val azureApiVersion: String, val correlationId: String, val debugSetting: DeploymentStacksDebugSettingResponse? = null, val deletedResources: List<ResourceReferenceResponse>, val denySettings: DenySettingsResponse, val deploymentId: String, val deploymentScope: String? = null, val description: String? = null, val detachedResources: List<ResourceReferenceResponse>, val duration: String, val error: ErrorDetailResponse? = null, val failedResources: List<ResourceReferenceExtendedResponse>, val id: String, val location: String? = null, val name: String, val outputs: Any, val parameters: Map<String, DeploymentParameterResponse>? = null, val parametersLink: DeploymentStacksParametersLinkResponse? = null, val provisioningState: String, val resources: List<ManagedResourceReferenceResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Deployment stack object.

Link copied to clipboard
data class GetDeploymentStackAtSubscriptionResult(val actionOnUnmanage: ActionOnUnmanageResponse, val azureApiVersion: String, val correlationId: String, val debugSetting: DeploymentStacksDebugSettingResponse? = null, val deletedResources: List<ResourceReferenceResponse>, val denySettings: DenySettingsResponse, val deploymentId: String, val deploymentScope: String? = null, val description: String? = null, val detachedResources: List<ResourceReferenceResponse>, val duration: String, val error: ErrorDetailResponse? = null, val failedResources: List<ResourceReferenceExtendedResponse>, val id: String, val location: String? = null, val name: String, val outputs: Any, val parameters: Map<String, DeploymentParameterResponse>? = null, val parametersLink: DeploymentStacksParametersLinkResponse? = null, val provisioningState: String, val resources: List<ManagedResourceReferenceResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Deployment stack object.

Link copied to clipboard
data class GetResourceGroupResult(val azureApiVersion: String, val id: String, val location: String, val managedBy: String? = null, val name: String, val properties: ResourceGroupPropertiesResponse, val tags: Map<String, String>? = null, val type: String)

Resource group information.

Link copied to clipboard
data class GetResourceResult(val azureApiVersion: String, val extendedLocation: ExtendedLocationResponse? = null, val id: String, val identity: IdentityResponse? = null, val kind: String? = null, val location: String? = null, val managedBy: String? = null, val name: String, val plan: PlanResponse? = null, val properties: Any, val sku: SkuResponse? = null, val tags: Map<String, String>? = null, val type: String)

Resource information.

Link copied to clipboard
data class GetTagAtScopeResult(val azureApiVersion: String, val id: String, val name: String, val properties: TagsResponse, val type: String)

Wrapper resource for tags API requests and responses.

Link copied to clipboard
data class GetTemplateSpecResult(val azureApiVersion: String, val description: String? = null, val displayName: String? = null, val id: String, val location: String, val metadata: Any? = null, val name: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val versions: Map<String, TemplateSpecVersionInfoResponse>)

Template Spec object.

Link copied to clipboard
data class GetTemplateSpecVersionResult(val azureApiVersion: String, val description: String? = null, val id: String, val linkedTemplates: List<LinkedTemplateArtifactResponse>? = null, val location: String, val mainTemplate: Any? = null, val metadata: Any? = null, val name: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val uiFormDefinition: Any? = null)

Template Spec Version object.

Link copied to clipboard
data class IdentityResponse(val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, IdentityResponseUserAssignedIdentities>? = null)

Identity for the resource.

Link copied to clipboard
data class IdentityResponseUserAssignedIdentities(val clientId: String, val principalId: String)
Link copied to clipboard
data class KeyVaultParameterReferenceResponse(val keyVault: KeyVaultReferenceResponse, val secretName: String, val secretVersion: String? = null)

Azure Key Vault parameter reference.

Link copied to clipboard
data class KeyVaultReferenceResponse(val id: String)

Azure Key Vault reference.

Link copied to clipboard
data class LinkedTemplateArtifactResponse(val path: String, val template: Any)

Represents a Template Spec artifact containing an embedded Azure Resource Manager template for use as a linked template.

Link copied to clipboard
data class ManagedResourceReferenceResponse(val denyStatus: String? = null, val id: String, val status: String? = null)

The managed resource model.

Link copied to clipboard
data class ManagedServiceIdentityResponse(val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Managed identity generic object.

Link copied to clipboard
data class OnErrorDeploymentExtendedResponse(val deploymentName: String? = null, val provisioningState: String, val type: String? = null)

Deployment on error behavior with additional details.

Link copied to clipboard
data class ParametersLinkResponse(val contentVersion: String? = null, val uri: String)

Entity representing the reference to the deployment parameters.

Link copied to clipboard
data class PlanResponse(val name: String? = null, val product: String? = null, val promotionCode: String? = null, val publisher: String? = null, val version: String? = null)

Plan for the resource.

Link copied to clipboard
data class ProviderExtendedLocationResponse(val extendedLocations: List<String>? = null, val location: String? = null, val type: String? = null)

The provider extended location.

Link copied to clipboard
data class ProviderResourceTypeResponse(val aliases: List<AliasResponse>? = null, val apiProfiles: List<ApiProfileResponse>, val apiVersions: List<String>? = null, val capabilities: String? = null, val defaultApiVersion: String, val locationMappings: List<ProviderExtendedLocationResponse>? = null, val locations: List<String>? = null, val properties: Map<String, String>? = null, val resourceType: String? = null, val zoneMappings: List<ZoneMappingResponse>? = null)

Resource type managed by the resource provider.

Link copied to clipboard
data class ProviderResponse(val id: String, val namespace: String? = null, val providerAuthorizationConsentState: String? = null, val registrationPolicy: String, val registrationState: String, val resourceTypes: List<ProviderResourceTypeResponse>)

Resource provider information.

Link copied to clipboard
data class ResourceGroupPropertiesResponse(val provisioningState: String)

The resource group properties.

Link copied to clipboard
data class ResourceReferenceExtendedResponse(val error: ErrorDetailResponse? = null, val id: String)

The resourceId extended model. This is used to document failed resources with a resourceId and a corresponding error.

Link copied to clipboard
data class ResourceReferenceResponse(val id: String)

The resourceId model.

Link copied to clipboard
data class ScriptStatusResponse(val containerInstanceId: String, val endTime: String, val error: ErrorResponseResponse? = null, val expirationTime: String, val startTime: String, val storageAccountId: String)

Generic object modeling results of script execution.

Link copied to clipboard
data class SkuResponse(val capacity: Int? = null, val family: String? = null, val model: String? = null, val name: String? = null, val size: String? = null, val tier: String? = null)

SKU for the resource.

Link copied to clipboard
data class StorageAccountConfigurationResponse(val storageAccountKey: String? = null, val storageAccountName: String? = null)

Settings to use an existing storage account. Valid storage account kinds are: Storage, StorageV2 and FileStorage

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TagsResponse(val tags: Map<String, String>? = null)

A dictionary of name and value pairs.

Link copied to clipboard
data class TemplateLinkResponse(val contentVersion: String? = null, val id: String? = null, val queryString: String? = null, val relativePath: String? = null, val uri: String? = null)

Entity representing the reference to the template.

Link copied to clipboard
data class TemplateSpecVersionInfoResponse(val description: String, val timeCreated: String, val timeModified: String)

High-level information about a Template Spec version.

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User-assigned managed identity.

Link copied to clipboard
data class ZoneMappingResponse(val location: String? = null, val zones: List<String>? = null)