Package-level declarations

Types

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

/* Defines how resources deployed by a blueprint assignment are locked.

Link copied to clipboard
data class AssignmentStatusResponse(val lastModified: String, val managedResources: List<String>, val timeCreated: String)

The status of a blueprint assignment. This field is readonly.

Link copied to clipboard
data class BlueprintStatusResponse(val lastModified: String, val timeCreated: String)

The status of the blueprint. This field is readonly.

Link copied to clipboard
data class GetAssignmentResult(val blueprintId: String? = null, val description: String? = null, val displayName: String? = null, val id: String, val identity: ManagedServiceIdentityResponse, val location: String, val locks: AssignmentLockSettingsResponse? = null, val name: String, val parameters: Map<String, ParameterValueResponse>, val provisioningState: String, val resourceGroups: Map<String, ResourceGroupValueResponse>, val scope: String? = null, val status: AssignmentStatusResponse, val type: String)

Represents a blueprint assignment.

Link copied to clipboard
data class GetBlueprintResult(val description: String? = null, val displayName: String? = null, val id: String, val layout: Any, val name: String, val parameters: Map<String, ParameterDefinitionResponse>? = null, val resourceGroups: Map<String, ResourceGroupDefinitionResponse>? = null, val status: BlueprintStatusResponse, val targetScope: String, val type: String, val versions: Any? = null)

Represents a Blueprint definition.

Link copied to clipboard
data class GetPolicyAssignmentArtifactResult(val dependsOn: List<String>? = null, val description: String? = null, val displayName: String? = null, val id: String, val kind: String, val name: String, val parameters: Map<String, ParameterValueResponse>, val policyDefinitionId: String, val resourceGroup: String? = null, val type: String)

Blueprint artifact that applies a Policy assignment.

Link copied to clipboard
data class GetPublishedBlueprintResult(val blueprintName: String? = null, val changeNotes: String? = null, val description: String? = null, val displayName: String? = null, val id: String, val name: String, val parameters: Map<String, ParameterDefinitionResponse>? = null, val resourceGroups: Map<String, ResourceGroupDefinitionResponse>? = null, val status: BlueprintStatusResponse, val targetScope: String? = null, val type: String)

Represents a published blueprint.

Link copied to clipboard
data class GetRoleAssignmentArtifactResult(val dependsOn: List<String>? = null, val description: String? = null, val displayName: String? = null, val id: String, val kind: String, val name: String, val principalIds: Any, val resourceGroup: String? = null, val roleDefinitionId: String, val type: String)

Blueprint artifact that applies a Role assignment.

Link copied to clipboard
data class GetTemplateArtifactResult(val dependsOn: List<String>? = null, val description: String? = null, val displayName: String? = null, val id: String, val kind: String, val name: String, val parameters: Map<String, ParameterValueResponse>, val resourceGroup: String? = null, val template: Any, val type: String)

Blueprint artifact that deploys a Resource Manager template.

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

Specifies the link to a Key Vault.

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

Managed identity generic object.

Link copied to clipboard
data class ParameterDefinitionResponse(val allowedValues: List<Any>? = null, val defaultValue: Any? = null, val description: String? = null, val displayName: String? = null, val strongType: String? = null, val type: String)

Represent a parameter with constrains and metadata.

Link copied to clipboard
data class ParameterValueResponse(val reference: SecretValueReferenceResponse? = null, val value: Any? = null)

Value for the specified parameter. Can be either 'value' or 'reference' but not both.

Link copied to clipboard
data class ResourceGroupDefinitionResponse(val dependsOn: List<String>? = null, val description: String? = null, val displayName: String? = null, val location: String? = null, val name: String? = null, val strongType: String? = null, val tags: Map<String, String>? = null)

Represents an Azure resource group in a blueprint definition.

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

Represents an Azure resource group.

Link copied to clipboard
data class SecretValueReferenceResponse(val keyVault: KeyVaultReferenceResponse, val secretName: String, val secretVersion: String? = null)

Reference to a Key Vault secret.

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

User-assigned managed identity.