Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The organizations resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Astronomer.Astro/organizations resource, add the following Bicep to your template.
resource symbolicname 'Astronomer.Astro/organizations@2024-08-27-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
marketplace: {
offerDetails: {
offerId: 'string'
planId: 'string'
planName: 'string'
publisherId: 'string'
renewalMode: 'string'
termId: 'string'
termUnit: 'string'
}
subscriptionId: 'string'
subscriptionStatus: 'string'
}
partnerOrganizationProperties: {
organizationId: 'string'
organizationName: 'string'
singleSignOnProperties: {
aadDomains: [
'string'
]
enterpriseAppId: 'string'
singleSignOnState: 'string'
singleSignOnUrl: 'string'
}
workspaceId: 'string'
workspaceName: 'string'
}
user: {
emailAddress: 'string'
firstName: 'string'
lastName: 'string'
phoneNumber: 'string'
upn: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Astronomer.Astro/organizations
| Name | Description | Value |
|---|---|---|
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 50 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$ (required) |
| properties | The resource-specific properties for this resource. | LiftrBaseDataOrganizationProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
LiftrBaseDataOrganizationProperties
| Name | Description | Value |
|---|---|---|
| marketplace | Marketplace details of the resource. | LiftrBaseMarketplaceDetails (required) |
| partnerOrganizationProperties | Organization properties | LiftrBaseDataPartnerOrganizationProperties |
| user | Details of the user. | LiftrBaseUserDetails (required) |
LiftrBaseDataPartnerOrganizationProperties
| Name | Description | Value |
|---|---|---|
| organizationId | Organization Id in partner's system | string |
| organizationName | Organization name in partner's system | string Constraints: Min length = 1 Max length = 50 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$ (required) |
| singleSignOnProperties | Single Sign On properties for the organization | LiftrBaseSingleSignOnProperties |
| workspaceId | Workspace Id in partner's system | string |
| workspaceName | Workspace name in partner's system | string Constraints: Min length = 1 Max length = 50 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$ |
LiftrBaseMarketplaceDetails
| Name | Description | Value |
|---|---|---|
| offerDetails | Offer details for the marketplace that is selected by the user | LiftrBaseOfferDetails (required) |
| subscriptionId | Azure subscription id for the the marketplace offer is purchased from | string |
| subscriptionStatus | Marketplace subscription status | 'PendingFulfillmentStart' 'Subscribed' 'Suspended' 'Unsubscribed' |
LiftrBaseOfferDetails
| Name | Description | Value |
|---|---|---|
| offerId | Offer Id for the marketplace offer | string (required) |
| planId | Plan Id for the marketplace offer | string (required) |
| planName | Plan Name for the marketplace offer | string |
| publisherId | Publisher Id for the marketplace offer | string (required) |
| renewalMode | Subscription renewal mode | 'Auto' 'Manual' |
| termId | Plan Display Name for the marketplace offer | string |
| termUnit | Plan Display Name for the marketplace offer | string |
LiftrBaseSingleSignOnProperties
| Name | Description | Value |
|---|---|---|
| aadDomains | List of AAD domains fetched from Microsoft Graph for user. | string[] |
| enterpriseAppId | AAD enterprise application Id used to setup SSO | string |
| singleSignOnState | State of the Single Sign On for the organization | 'Disable' 'Enable' 'Initial' |
| singleSignOnUrl | URL for SSO to be used by the partner to redirect the user to their system | string |
LiftrBaseUserDetails
| Name | Description | Value |
|---|---|---|
| emailAddress | Email address of the user | string Constraints: Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$ (required) |
| firstName | First name of the user | string (required) |
| lastName | Last name of the user | string (required) |
| phoneNumber | User's phone number | string |
| upn | User's principal name | string |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
ARM template resource definition
The organizations resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Astronomer.Astro/organizations resource, add the following JSON to your template.
{
"type": "Astronomer.Astro/organizations",
"apiVersion": "2024-08-27-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"marketplace": {
"offerDetails": {
"offerId": "string",
"planId": "string",
"planName": "string",
"publisherId": "string",
"renewalMode": "string",
"termId": "string",
"termUnit": "string"
},
"subscriptionId": "string",
"subscriptionStatus": "string"
},
"partnerOrganizationProperties": {
"organizationId": "string",
"organizationName": "string",
"singleSignOnProperties": {
"aadDomains": [ "string" ],
"enterpriseAppId": "string",
"singleSignOnState": "string",
"singleSignOnUrl": "string"
},
"workspaceId": "string",
"workspaceName": "string"
},
"user": {
"emailAddress": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"upn": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Astronomer.Astro/organizations
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-08-27-preview' |
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 50 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$ (required) |
| properties | The resource-specific properties for this resource. | LiftrBaseDataOrganizationProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Astronomer.Astro/organizations' |
LiftrBaseDataOrganizationProperties
| Name | Description | Value |
|---|---|---|
| marketplace | Marketplace details of the resource. | LiftrBaseMarketplaceDetails (required) |
| partnerOrganizationProperties | Organization properties | LiftrBaseDataPartnerOrganizationProperties |
| user | Details of the user. | LiftrBaseUserDetails (required) |
LiftrBaseDataPartnerOrganizationProperties
| Name | Description | Value |
|---|---|---|
| organizationId | Organization Id in partner's system | string |
| organizationName | Organization name in partner's system | string Constraints: Min length = 1 Max length = 50 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$ (required) |
| singleSignOnProperties | Single Sign On properties for the organization | LiftrBaseSingleSignOnProperties |
| workspaceId | Workspace Id in partner's system | string |
| workspaceName | Workspace name in partner's system | string Constraints: Min length = 1 Max length = 50 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$ |
LiftrBaseMarketplaceDetails
| Name | Description | Value |
|---|---|---|
| offerDetails | Offer details for the marketplace that is selected by the user | LiftrBaseOfferDetails (required) |
| subscriptionId | Azure subscription id for the the marketplace offer is purchased from | string |
| subscriptionStatus | Marketplace subscription status | 'PendingFulfillmentStart' 'Subscribed' 'Suspended' 'Unsubscribed' |
LiftrBaseOfferDetails
| Name | Description | Value |
|---|---|---|
| offerId | Offer Id for the marketplace offer | string (required) |
| planId | Plan Id for the marketplace offer | string (required) |
| planName | Plan Name for the marketplace offer | string |
| publisherId | Publisher Id for the marketplace offer | string (required) |
| renewalMode | Subscription renewal mode | 'Auto' 'Manual' |
| termId | Plan Display Name for the marketplace offer | string |
| termUnit | Plan Display Name for the marketplace offer | string |
LiftrBaseSingleSignOnProperties
| Name | Description | Value |
|---|---|---|
| aadDomains | List of AAD domains fetched from Microsoft Graph for user. | string[] |
| enterpriseAppId | AAD enterprise application Id used to setup SSO | string |
| singleSignOnState | State of the Single Sign On for the organization | 'Disable' 'Enable' 'Initial' |
| singleSignOnUrl | URL for SSO to be used by the partner to redirect the user to their system | string |
LiftrBaseUserDetails
| Name | Description | Value |
|---|---|---|
| emailAddress | Email address of the user | string Constraints: Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$ (required) |
| firstName | First name of the user | string (required) |
| lastName | Last name of the user | string (required) |
| phoneNumber | User's phone number | string |
| upn | User's principal name | string |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The organizations resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Astronomer.Astro/organizations resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Astronomer.Astro/organizations@2024-08-27-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
marketplace = {
offerDetails = {
offerId = "string"
planId = "string"
planName = "string"
publisherId = "string"
renewalMode = "string"
termId = "string"
termUnit = "string"
}
subscriptionId = "string"
subscriptionStatus = "string"
}
partnerOrganizationProperties = {
organizationId = "string"
organizationName = "string"
singleSignOnProperties = {
aadDomains = [
"string"
]
enterpriseAppId = "string"
singleSignOnState = "string"
singleSignOnUrl = "string"
}
workspaceId = "string"
workspaceName = "string"
}
user = {
emailAddress = "string"
firstName = "string"
lastName = "string"
phoneNumber = "string"
upn = "string"
}
}
}
}
Property Values
Astronomer.Astro/organizations
| Name | Description | Value |
|---|---|---|
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 50 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$ (required) |
| properties | The resource-specific properties for this resource. | LiftrBaseDataOrganizationProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Astronomer.Astro/organizations@2024-08-27-preview" |
LiftrBaseDataOrganizationProperties
| Name | Description | Value |
|---|---|---|
| marketplace | Marketplace details of the resource. | LiftrBaseMarketplaceDetails (required) |
| partnerOrganizationProperties | Organization properties | LiftrBaseDataPartnerOrganizationProperties |
| user | Details of the user. | LiftrBaseUserDetails (required) |
LiftrBaseDataPartnerOrganizationProperties
| Name | Description | Value |
|---|---|---|
| organizationId | Organization Id in partner's system | string |
| organizationName | Organization name in partner's system | string Constraints: Min length = 1 Max length = 50 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$ (required) |
| singleSignOnProperties | Single Sign On properties for the organization | LiftrBaseSingleSignOnProperties |
| workspaceId | Workspace Id in partner's system | string |
| workspaceName | Workspace name in partner's system | string Constraints: Min length = 1 Max length = 50 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$ |
LiftrBaseMarketplaceDetails
| Name | Description | Value |
|---|---|---|
| offerDetails | Offer details for the marketplace that is selected by the user | LiftrBaseOfferDetails (required) |
| subscriptionId | Azure subscription id for the the marketplace offer is purchased from | string |
| subscriptionStatus | Marketplace subscription status | 'PendingFulfillmentStart' 'Subscribed' 'Suspended' 'Unsubscribed' |
LiftrBaseOfferDetails
| Name | Description | Value |
|---|---|---|
| offerId | Offer Id for the marketplace offer | string (required) |
| planId | Plan Id for the marketplace offer | string (required) |
| planName | Plan Name for the marketplace offer | string |
| publisherId | Publisher Id for the marketplace offer | string (required) |
| renewalMode | Subscription renewal mode | 'Auto' 'Manual' |
| termId | Plan Display Name for the marketplace offer | string |
| termUnit | Plan Display Name for the marketplace offer | string |
LiftrBaseSingleSignOnProperties
| Name | Description | Value |
|---|---|---|
| aadDomains | List of AAD domains fetched from Microsoft Graph for user. | string[] |
| enterpriseAppId | AAD enterprise application Id used to setup SSO | string |
| singleSignOnState | State of the Single Sign On for the organization | 'Disable' 'Enable' 'Initial' |
| singleSignOnUrl | URL for SSO to be used by the partner to redirect the user to their system | string |
LiftrBaseUserDetails
| Name | Description | Value |
|---|---|---|
| emailAddress | Email address of the user | string Constraints: Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$ (required) |
| firstName | First name of the user | string (required) |
| lastName | Last name of the user | string (required) |
| phoneNumber | User's phone number | string |
| upn | User's principal name | string |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|