swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Organizations API schemes: - https tags: - name: Organizations paths: /subscriptions/{subscriptionId}/providers/Astronomer.Astro/organizations: get: operationId: microsoftAzureOrganizationsListbysubscription tags: - Organizations description: List OrganizationResource resources by subscription ID parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/OrganizationResourceListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Organizations_ListBySubscription - generated by [MaximumSet] rule: $ref: ./examples/Organizations_ListBySubscription_MaximumSet_Gen.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Astronomer Astro Organizations /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Astronomer.Astro/organizations: get: operationId: microsoftAzureOrganizationsListbyresourcegroup tags: - Organizations description: List OrganizationResource resources by resource group parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/OrganizationResourceListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Organizations_ListByResourceGroup - generated by [MaximumSet] rule: $ref: ./examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Astronomer Astro Organizations ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Astronomer.Astro/organizations/{organizationName} : get: operationId: microsoftAzureOrganizationsGet tags: - Organizations description: Get a OrganizationResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: organizationName in: path description: Name of the Organizations resource required: true type: string minLength: 1 maxLength: 50 pattern: '^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$' responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/OrganizationResource' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Organizations_Get - generated by [MaximumSet] rule: $ref: ./examples/Organizations_Get_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Astronomer Astro Organizations Organizationname put: operationId: microsoftAzureOrganizationsCreateorupdate tags: - Organizations description: Create a OrganizationResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: organizationName in: path description: Name of the Organizations resource required: true type: string minLength: 1 maxLength: 50 pattern: '^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$' - name: resource in: body description: Resource create parameters. required: true schema: $ref: '#/definitions/OrganizationResource' responses: '200': description: Resource 'OrganizationResource' update operation succeeded schema: $ref: '#/definitions/OrganizationResource' '201': description: Resource 'OrganizationResource' create operation succeeded schema: $ref: '#/definitions/OrganizationResource' headers: Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Organizations_CreateOrUpdate - generated by [MaximumSet] rule: $ref: ./examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Astronomer Astro Organizations Organizationname patch: operationId: microsoftAzureOrganizationsUpdate tags: - Organizations description: Update a OrganizationResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: organizationName in: path description: Name of the Organizations resource required: true type: string minLength: 1 maxLength: 50 pattern: '^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$' - name: properties in: body description: The resource properties to be updated. required: true schema: $ref: '#/definitions/OrganizationResourceUpdate' responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/OrganizationResource' '202': description: Resource update request accepted. headers: Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Organizations_Update: $ref: ./examples/Organizations_Update_MaximumSet_Gen.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Astronomer Astro Organizations Organizationname delete: operationId: microsoftAzureOrganizationsDelete tags: - Organizations description: Delete a OrganizationResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: organizationName in: path description: Name of the Organizations resource required: true type: string minLength: 1 maxLength: 50 pattern: '^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$' responses: '202': description: Resource deletion accepted. headers: Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. Location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. '204': description: Resource deleted successfully. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Organizations_Delete - generated by [MaximumSet] rule: $ref: ./examples/Organizations_Delete_MaximumSet_Gen.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Astronomer Astro Organizations Organizationname /organizations: get: operationId: microsoftAzureOrganizationsList summary: Microsoft Azure Get The List Of Organizations The User Has Access To In An Application x-ms-examples: List organizations: $ref: ./examples/organizations_list.json parameters: - $ref: '#/parameters/Version' x-ms-pageable: nextLinkName: nextLink responses: '200': description: Success schema: $ref: '#/definitions/OrganizationCollection' default: description: An error response received from the IoT Central Service. headers: x-ms-error-code: type: string description: Error code for specific error that occurred. schema: $ref: '#/definitions/Error' description: Needs a more full description created. tags: - Organizations /organizations/{organizationId}: get: operationId: microsoftAzureOrganizationsGet summary: Microsoft Azure Get An Organization By Id x-ms-examples: Get organization: $ref: ./examples/organizations_get.json parameters: - $ref: '#/parameters/Version' - $ref: '#/parameters/OrganizationId' responses: '200': description: Success schema: $ref: '#/definitions/Organization' default: description: An error response received from the IoT Central Service. headers: x-ms-error-code: type: string description: Error code for specific error that occurred. schema: $ref: '#/definitions/Error' description: Needs a more full description created. tags: - Organizations put: operationId: microsoftAzureOrganizationsCreate summary: Microsoft Azure Create An Organization In The Application x-ms-examples: Add or update organization: $ref: ./examples/organizations_create.json parameters: - $ref: '#/parameters/Version' - $ref: '#/parameters/OrganizationId' - in: body name: body description: Organization body. schema: $ref: '#/definitions/Organization' required: true responses: '200': description: Success schema: $ref: '#/definitions/Organization' default: description: An error response received from the IoT Central Service. headers: x-ms-error-code: type: string description: Error code for specific error that occurred. schema: $ref: '#/definitions/Error' description: Needs a more full description created. tags: - Organizations patch: operationId: microsoftAzureOrganizationsUpdate summary: Microsoft Azure Update An Organization In The Application Via Patch x-ms-examples: Update organization: $ref: ./examples/organizations_create.json consumes: - application/json - application/merge-patch+json parameters: - $ref: '#/parameters/Version' - $ref: '#/parameters/OrganizationId' - in: body name: body description: Organization patch body. schema: type: object required: true - $ref: '#/parameters/IfMatch' responses: '200': description: Success schema: $ref: '#/definitions/Organization' default: description: An error response received from the IoT Central Service. headers: x-ms-error-code: type: string description: Error code for specific error that occurred. schema: $ref: '#/definitions/Error' description: Needs a more full description created. tags: - Organizations delete: operationId: microsoftAzureOrganizationsRemove summary: Microsoft Azure Delete An Organization x-ms-examples: Delete organization: $ref: ./examples/organizations_delete.json parameters: - $ref: '#/parameters/Version' - $ref: '#/parameters/OrganizationId' responses: '204': description: Success default: description: An error response received from the IoT Central Service. headers: x-ms-error-code: type: string description: Error code for specific error that occurred. schema: $ref: '#/definitions/Error' description: Needs a more full description created. tags: - Organizations /subscriptions/{subscriptionId}/providers/NewRelic.Observability/organizations: get: tags: - Organizations operationId: microsoftAzureOrganizationsList description: List all the existing organizations parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/UserEmailParameter' - $ref: '#/parameters/LocationParameter' responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/OrganizationsListResponse' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Organizations_List_MaximumSet_Gen: $ref: ./examples/Organizations_List_MaximumSet_Gen.json Organizations_List_MinimumSet_Gen: $ref: ./examples/Organizations_List_MinimumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Newrelic Observability Organizations definitions: OrganizationsListResponse: type: object properties: value: type: array items: $ref: '#/definitions/OrganizationResource_2' x-cadl-name: OrganizationResource[] description: The OrganizationResource items on this page nextLink: type: string format: uri description: The link to the next page of items x-cadl-name: Rest.ResourceLocation description: Response of get all organizations Operation. required: - value LiftrBase.Data.PartnerOrganizationPropertiesUpdate: type: object description: Properties specific to Partner's organization properties: organizationId: type: string description: Organization Id in partner's system workspaceId: type: string description: Workspace Id in partner's system organizationName: type: string description: Organization name in partner's system minLength: 1 maxLength: 50 pattern: '^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$' workspaceName: type: string description: Workspace name in partner's system minLength: 1 maxLength: 50 pattern: '^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$' singleSignOnProperties: $ref: '#/definitions/LiftrBase.SingleSignOnProperties' description: Single Sign On properties for the organization ErrorDetails: description: The detail information of the error. type: object properties: code: type: string description: Error code. message: type: string description: Error message details. requestId: type: string description: Correlation Id for current request. time: type: string format: date-time-rfc1123 description: The time that error request failed. required: - code - message OrganizationResourceUpdateProperties: type: object description: The updatable properties of the OrganizationResource. properties: user: $ref: '#/definitions/LiftrBase.UserDetailsUpdate' description: Details of the user. partnerOrganizationProperties: $ref: '#/definitions/LiftrBase.Data.PartnerOrganizationPropertiesUpdate' description: Organization properties LiftrBase.UserDetails: type: object description: User details for an organization properties: firstName: type: string description: First name of the user lastName: type: string description: Last name of the user emailAddress: $ref: '#/definitions/LiftrBase.email' description: Email address of the user upn: type: string description: User's principal name phoneNumber: type: string description: User's phone number required: - firstName - lastName - emailAddress LiftrBase.MarketplaceSubscriptionStatus: type: string description: Marketplace subscription status of a resource. enum: - PendingFulfillmentStart - Subscribed - Suspended - Unsubscribed x-ms-enum: name: MarketplaceSubscriptionStatus modelAsString: true values: - name: PendingFulfillmentStart value: PendingFulfillmentStart description: Purchased but not yet activated - name: Subscribed value: Subscribed description: Marketplace subscription is activated - name: Suspended value: Suspended description: This state indicates that a customer's payment for the Marketplace service was not received - name: Unsubscribed value: Unsubscribed description: Customer has cancelled the subscription BillingSource: type: string description: Billing source enum: - AZURE - NEWRELIC x-ms-enum: name: BillingSource modelAsString: true values: - name: AZURE value: AZURE description: Billing source is Azure - name: NEWRELIC value: NEWRELIC LiftrBase.Uri: type: string description: A string that represents a URI. OrganizationProperties: type: object properties: organizationId: type: string description: organization id organizationName: type: string description: organization name billingSource: $ref: '#/definitions/BillingSource' description: Billing source description: Details of Organizations LiftrBase.Data.PartnerOrganizationProperties: type: object description: Properties specific to Partner's organization properties: organizationId: type: string description: Organization Id in partner's system workspaceId: type: string description: Workspace Id in partner's system organizationName: type: string description: Organization name in partner's system minLength: 1 maxLength: 50 pattern: '^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$' workspaceName: type: string description: Workspace name in partner's system minLength: 1 maxLength: 50 pattern: '^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$' singleSignOnProperties: $ref: '#/definitions/LiftrBase.SingleSignOnProperties' description: Single Sign On properties for the organization required: - organizationName Azure.ResourceManager.ResourceProvisioningState: type: string description: The provisioning state of a resource type. enum: - Succeeded - Failed - Canceled x-ms-enum: name: ResourceProvisioningState modelAsString: true values: - name: Succeeded value: Succeeded description: Resource has been created. - name: Failed value: Failed description: Resource creation failed. - name: Canceled value: Canceled description: Resource creation was canceled. LiftrBase.SingleSignOnProperties: type: object description: Properties specific to Single Sign On Resource properties: singleSignOnState: $ref: '#/definitions/LiftrBase.SingleSignOnStates' description: State of the Single Sign On for the organization enterpriseAppId: type: string description: AAD enterprise application Id used to setup SSO singleSignOnUrl: $ref: '#/definitions/LiftrBase.Uri' description: URL for SSO to be used by the partner to redirect the user to their system aadDomains: type: array description: List of AAD domains fetched from Microsoft Graph for user. items: type: string provisioningState: $ref: '#/definitions/Azure.ResourceManager.ResourceProvisioningState' description: Provisioning State of the resource readOnly: true LiftrBase.OfferDetails: type: object description: Offer details for the marketplace that is selected by the user properties: publisherId: type: string description: Publisher Id for the marketplace offer offerId: type: string description: Offer Id for the marketplace offer planId: type: string description: Plan Id for the marketplace offer planName: type: string description: Plan Name for the marketplace offer termUnit: type: string description: Plan Display Name for the marketplace offer termId: type: string description: Plan Display Name for the marketplace offer required: - publisherId - offerId - planId OrganizationResource_2: type: object properties: properties: $ref: '#/definitions/OrganizationProperties' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create description: The details of a Organization resource. allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource LiftrBase.UserDetailsUpdate: type: object description: User details for an organization properties: firstName: type: string description: First name of the user lastName: type: string description: Last name of the user emailAddress: $ref: '#/definitions/LiftrBase.email' description: Email address of the user upn: type: string description: User's principal name phoneNumber: type: string description: User's phone number Organization: description: The organization definition. type: object properties: id: description: Unique ID of the organization. type: string readOnly: true displayName: description: Display name of the organization. type: string parent: description: ID of the parent of the organization. type: string OrganizationResourceUpdate: type: object description: The type used for update operations of the OrganizationResource. properties: identity: $ref: ../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity description: The managed service identities assigned to this resource. tags: type: object description: Resource tags. additionalProperties: type: string properties: $ref: '#/definitions/OrganizationResourceUpdateProperties' x-ms-client-flatten: true LiftrBase.email: type: string description: Reusable representation of an email address. pattern: ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$ LiftrBase.SingleSignOnStates: type: string description: Various states of the SSO resource enum: - Initial - Enable - Disable x-ms-enum: name: SingleSignOnStates modelAsString: true values: - name: Initial value: Initial description: Initial state of the SSO resource - name: Enable value: Enable description: State of the SSO resource when it is enabled - name: Disable value: Disable description: State of the SSO resource when it is disabled Error: description: The response error definition. type: object properties: error: description: Error details for current request. $ref: '#/definitions/ErrorDetails' required: - error LiftrBase.MarketplaceDetails: type: object description: Marketplace details for an organization properties: subscriptionId: type: string description: Azure subscription id for the the marketplace offer is purchased from subscriptionStatus: $ref: '#/definitions/LiftrBase.MarketplaceSubscriptionStatus' description: Marketplace subscription status offerDetails: $ref: '#/definitions/LiftrBase.OfferDetails' description: Offer details for the marketplace that is selected by the user required: - subscriptionId - offerDetails LiftrBase.Data.OrganizationProperties: type: object description: Properties specific to Data Organization resource properties: marketplace: $ref: '#/definitions/LiftrBase.MarketplaceDetails' description: Marketplace details of the resource. x-ms-mutability: - read - create user: $ref: '#/definitions/LiftrBase.UserDetails' description: Details of the user. provisioningState: $ref: '#/definitions/Azure.ResourceManager.ResourceProvisioningState' description: Provisioning state of the resource. readOnly: true partnerOrganizationProperties: $ref: '#/definitions/LiftrBase.Data.PartnerOrganizationProperties' description: Organization properties required: - marketplace - user OrganizationResource: type: object description: Organization Resource by Astronomer properties: properties: $ref: '#/definitions/LiftrBase.Data.OrganizationProperties' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create identity: $ref: ../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity description: The managed service identities assigned to this resource. allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource OrganizationResourceListResult: type: object description: The response of a OrganizationResource list operation. properties: value: type: array description: The OrganizationResource items on this page items: $ref: '#/definitions/OrganizationResource' nextLink: type: string format: uri description: The link to the next page of items required: - value OrganizationCollection: description: The paged results of organizations. type: object properties: value: description: The collection of organizations. type: array items: $ref: '#/definitions/Organization' nextLink: description: URL to get the next page of organizations. type: string required: - value parameters: LocationParameter: name: location in: query required: true description: Location for NewRelic. type: string x-ms-parameter-location: method OrganizationId: in: path name: organizationId description: Unique ID for the organization. x-ms-parameter-location: method type: string maxLength: 48 pattern: ^(?!-)[a-z0-9-]{1,48}[a-z0-9]$ required: true IfMatch: in: header name: If-Match description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided. x-ms-parameter-location: method type: string required: false UserEmailParameter: name: userEmail in: query required: true description: User Email. type: string x-ms-parameter-location: method Version: in: query name: api-version description: The version of the API being called. x-ms-parameter-location: client type: string required: true x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'