Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added builders and builds resource type api specifications #23697

Conversation

pauld-msft
Copy link
Member

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
    End of June
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    Mid-June
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
    OK

Contribution checklist (MS Employees Only):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[x] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @pauld-msft Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 24, 2023

    Swagger Validation Report

    ️🔄BreakingChange inProgress [Detail]
    ️⌛Breaking Change(Cross-Version) pending [Detail]
    ️🔄LintDiff inProgress [Detail]
    ️⌛Avocado pending [Detail]
    ️🔄SwaggerAPIView inProgress [Detail]
    ️⌛CadlAPIView pending [Detail]
    ️⌛TypeSpecAPIView pending [Detail]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️🔄SemanticValidation inProgress [Detail]
    ️⌛PrettierCheck pending [Detail]
    ️⌛SpellCheck pending [Detail]
    ️⌛CadlValidation pending [Detail]
    ️⌛TypeSpec Validation pending [Detail]
    ️⌛PR Summary pending [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 24, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️⚠️SDK Breaking Change Tracking warning [Detail]

    Breaking Changes Tracking

    ⚠️azure-sdk-for-python-track2 - track2_azure-mgmt-appcontainers - 2.0.0
    +	Model AvailableWorkloadProfileProperties no longer has parameter billing_meter_category
    +	Model ContainerApp no longer has parameter workload_profile_type
    +	Model ManagedEnvironment no longer has parameter sku
    +	Model VnetConfiguration no longer has parameter outbound_settings
    +	Model VnetConfiguration no longer has parameter runtime_subnet_id
    +	Model WorkloadProfile has a new required parameter name
    ⚠️azure-sdk-for-js - @azure/arm-appcontainers - 2.0.0-beta.3
    +	Interface ContainerAppsRevisionsListRevisionsNextOptionalParams no longer has parameter filter
    +	Interface VnetConfiguration no longer has parameter runtimeSubnetId
    +	Type of parameter customDomainVerificationFailureInfo of interface CustomHostnameAnalysisResult is changed from DefaultErrorResponse to CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo
    +	Type of parameter value of interface DaprSecretsCollection is changed from Secret[] to DaprSecret[]
    ⚠️azure-sdk-for-go - sdk/resourcemanager/appcontainers/armappcontainers - 2.0.0-beta.3
    +	Enum `Category` has been removed
    +	Enum `ManagedEnvironmentOutBoundType` has been removed
    +	Enum `SKUName` has been removed
    +	Field `BillingMeterCategory` of struct `AvailableWorkloadProfileProperties` has been removed
    +	Field `OutboundSettings`, `RuntimeSubnetID` of struct `VnetConfiguration` has been removed
    +	Field `SKU` of struct `ManagedEnvironment` has been removed
    +	Field `WorkloadProfileType` of struct `ContainerAppProperties` has been removed
    +	Struct `EnvironmentSKUProperties` has been removed
    +	Struct `ManagedEnvironmentOutboundSettings` has been removed
    +	Type of `BillingMeterProperties.Category` has been changed from `*Category` to `*string`
    +	Type of `CustomDomainConfiguration.CertificatePassword` has been changed from `[]byte` to `*string`
    +	Type of `DaprSecretsCollection.Value` has been changed from `[]*Secret` to `[]*DaprSecret`
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 5982e482f8edb83a94a2f4239c760240a44abe42. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
      cmderr	[automation_generate.sh] notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.6.6
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.6>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-appcontainers [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group BuildersOperations
      info	[Changelog]   - Added operation group BuildsOperations
      info	[Changelog]   - Added operation group JobsExecutionsOperations
      info	[Changelog]   - Added operation group JobsOperations
      info	[Changelog]   - Added operation group ManagedCertificatesOperations
      info	[Changelog]   - Model AvailableWorkloadProfileProperties has a new parameter category
      info	[Changelog]   - Model ContainerApp has a new parameter managed_by
      info	[Changelog]   - Model ContainerApp has a new parameter workload_profile_name
      info	[Changelog]   - Model ContainerAppSecret has a new parameter identity
      info	[Changelog]   - Model ContainerAppSecret has a new parameter key_vault_url
      info	[Changelog]   - Model Ingress has a new parameter sticky_sessions
      info	[Changelog]   - Model ManagedEnvironment has a new parameter dapr_configuration
      info	[Changelog]   - Model ManagedEnvironment has a new parameter infrastructure_resource_group
      info	[Changelog]   - Model ManagedEnvironment has a new parameter keda_configuration
      info	[Changelog]   - Model Replica has a new parameter init_containers
      info	[Changelog]   - Model Replica has a new parameter running_state
      info	[Changelog]   - Model Replica has a new parameter running_state_details
      info	[Changelog]   - Model ReplicaContainer has a new parameter running_state
      info	[Changelog]   - Model ReplicaContainer has a new parameter running_state_details
      info	[Changelog]   - Model Secret has a new parameter identity
      info	[Changelog]   - Model Secret has a new parameter key_vault_url
      info	[Changelog]   - Model Template has a new parameter termination_grace_period_seconds
      info	[Changelog]   - Model Volume has a new parameter mount_options
      info	[Changelog]   - Model Volume has a new parameter secrets
      info	[Changelog]   - Model VolumeMount has a new parameter sub_path
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Model AvailableWorkloadProfileProperties no longer has parameter billing_meter_category
      info	[Changelog]   - Model ContainerApp no longer has parameter workload_profile_type
      info	[Changelog]   - Model ManagedEnvironment no longer has parameter sku
      info	[Changelog]   - Model VnetConfiguration no longer has parameter outbound_settings
      info	[Changelog]   - Model VnetConfiguration no longer has parameter runtime_subnet_id
      info	[Changelog]   - Model WorkloadProfile has a new required parameter name
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 5982e482f8edb83a94a2f4239c760240a44abe42. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    • ️✔️azure-resourcemanager-appcontainers [View full logs]  [Preview SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 5982e482f8edb83a94a2f4239c760240a44abe42. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️sdk/resourcemanager/appcontainers/armappcontainers [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `BillingMeterProperties.Category` has been changed from `*Category` to `*string`
      info	[Changelog] - Type of `CustomDomainConfiguration.CertificatePassword` has been changed from `[]byte` to `*string`
      info	[Changelog] - Type of `DaprSecretsCollection.Value` has been changed from `[]*Secret` to `[]*DaprSecret`
      info	[Changelog] - Enum `Category` has been removed
      info	[Changelog] - Enum `ManagedEnvironmentOutBoundType` has been removed
      info	[Changelog] - Enum `SKUName` has been removed
      info	[Changelog] - Struct `EnvironmentSKUProperties` has been removed
      info	[Changelog] - Struct `ManagedEnvironmentOutboundSettings` has been removed
      info	[Changelog] - Field `BillingMeterCategory` of struct `AvailableWorkloadProfileProperties` has been removed
      info	[Changelog] - Field `WorkloadProfileType` of struct `ContainerAppProperties` has been removed
      info	[Changelog] - Field `SKU` of struct `ManagedEnvironment` has been removed
      info	[Changelog] - Field `OutboundSettings`, `RuntimeSubnetID` of struct `VnetConfiguration` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New value `StorageTypeSecret` added to enum type `StorageType`
      info	[Changelog] - New enum type `Affinity` with values `AffinityNone`, `AffinitySticky`
      info	[Changelog] - New enum type `BuildStatus` with values `BuildStatusCanceled`, `BuildStatusFailed`, `BuildStatusInProgress`, `BuildStatusNotStarted`, `BuildStatusSucceeded`
      info	[Changelog] - New enum type `ContainerAppContainerRunningState` with values `ContainerAppContainerRunningStateRunning`, `ContainerAppContainerRunningStateTerminated`, `ContainerAppContainerRunningStateWaiting`
      info	[Changelog] - New enum type `ContainerAppReplicaRunningState` with values `ContainerAppReplicaRunningStateNotRunning`, `ContainerAppReplicaRunningStateRunning`, `ContainerAppReplicaRunningStateUnknown`
      info	[Changelog] - New enum type `IngressClientCertificateMode` with values `IngressClientCertificateModeAccept`, `IngressClientCertificateModeIgnore`, `IngressClientCertificateModeRequire`
      info	[Changelog] - New enum type `JobExecutionRunningState` with values `JobExecutionRunningStateDegraded`, `JobExecutionRunningStateFailed`, `JobExecutionRunningStateProcessing`, `JobExecutionRunningStateRunning`, `JobExecutionRunningStateStopped`, `JobExecutionRunningStateSucceeded`, `JobExecutionRunningStateUnknown`
      info	[Changelog] - New enum type `JobProvisioningState` with values `JobProvisioningStateCanceled`, `JobProvisioningStateDeleting`, `JobProvisioningStateFailed`, `JobProvisioningStateInProgress`, `JobProvisioningStateSucceeded`
      info	[Changelog] - New enum type `ManagedCertificateDomainControlValidation` with values `ManagedCertificateDomainControlValidationCNAME`, `ManagedCertificateDomainControlValidationHTTP`, `ManagedCertificateDomainControlValidationTXT`
      info	[Changelog] - New enum type `ProvisioningState` with values `ProvisioningStateCanceled`, `ProvisioningStateDeleting`, `ProvisioningStateFailed`, `ProvisioningStateInProgress`, `ProvisioningStateSucceeded`
      info	[Changelog] - New enum type `TriggerType` with values `TriggerTypeEvent`, `TriggerTypeManual`, `TriggerTypeScheduled`
      info	[Changelog] - New function `NewBuildersClient(string, azcore.TokenCredential, *arm.ClientOptions) (*BuildersClient, error)`
      info	[Changelog] - New function `*BuildersClient.BeginCreateOrUpdate(context.Context, string, string, BuilderResource, *BuildersClientBeginCreateOrUpdateOptions) (*runtime.Poller[BuildersClientCreateOrUpdateResponse], error)`
      info	[Changelog] - New function `*BuildersClient.BeginDelete(context.Context, string, string, *BuildersClientBeginDeleteOptions) (*runtime.Poller[BuildersClientDeleteResponse], error)`
      info	[Changelog] - New function `*BuildersClient.Get(context.Context, string, string, *BuildersClientGetOptions) (BuildersClientGetResponse, error)`
      info	[Changelog] - New function `*BuildersClient.NewListByResourceGroupPager(string, *BuildersClientListByResourceGroupOptions) *runtime.Pager[BuildersClientListByResourceGroupResponse]`
      info	[Changelog] - New function `*BuildersClient.NewListBySubscriptionPager(*BuildersClientListBySubscriptionOptions) *runtime.Pager[BuildersClientListBySubscriptionResponse]`
      info	[Changelog] - New function `*BuildersClient.BeginUpdate(context.Context, string, string, BuilderResourceUpdate, *BuildersClientBeginUpdateOptions) (*runtime.Poller[BuildersClientUpdateResponse], error)`
      info	[Changelog] - New function `NewBuildsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*BuildsClient, error)`
      info	[Changelog] - New function `*BuildsClient.BeginCreateOrUpdate(context.Context, string, string, string, BuildResource, *BuildsClientBeginCreateOrUpdateOptions) (*runtime.Poller[BuildsClientCreateOrUpdateResponse], error)`
      info	[Changelog] - New function `*BuildsClient.BeginDelete(context.Context, string, string, string, *BuildsClientBeginDeleteOptions) (*runtime.Poller[BuildsClientDeleteResponse], error)`
      info	[Changelog] - New function `*BuildsClient.Get(context.Context, string, string, string, *BuildsClientGetOptions) (BuildsClientGetResponse, error)`
      info	[Changelog] - New function `*BuildsClient.NewListByBuilderResourcePager(string, string, *BuildsClientListByBuilderResourceOptions) *runtime.Pager[BuildsClientListByBuilderResourceResponse]`
      info	[Changelog] - New function `*ClientFactory.NewBuildersClient() *BuildersClient`
      info	[Changelog] - New function `*ClientFactory.NewBuildsClient() *BuildsClient`
      info	[Changelog] - New function `*ClientFactory.NewJobsClient() *JobsClient`
      info	[Changelog] - New function `*ClientFactory.NewJobsExecutionsClient() *JobsExecutionsClient`
      info	[Changelog] - New function `*ClientFactory.NewManagedCertificatesClient() *ManagedCertificatesClient`
      info	[Changelog] - New function `NewJobsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*JobsClient, error)`
      info	[Changelog] - New function `*JobsClient.BeginCreateOrUpdate(context.Context, string, string, Job, *JobsClientBeginCreateOrUpdateOptions) (*runtime.Poller[JobsClientCreateOrUpdateResponse], error)`
      info	[Changelog] - New function `*JobsClient.BeginDelete(context.Context, string, string, *JobsClientBeginDeleteOptions) (*runtime.Poller[JobsClientDeleteResponse], error)`
      info	[Changelog] - New function `*JobsClient.Get(context.Context, string, string, *JobsClientGetOptions) (JobsClientGetResponse, error)`
      info	[Changelog] - New function `*JobsClient.NewListByResourceGroupPager(string, *JobsClientListByResourceGroupOptions) *runtime.Pager[JobsClientListByResourceGroupResponse]`
      info	[Changelog] - New function `*JobsClient.NewListBySubscriptionPager(*JobsClientListBySubscriptionOptions) *runtime.Pager[JobsClientListBySubscriptionResponse]`
      info	[Changelog] - New function `*JobsClient.ListSecrets(context.Context, string, string, *JobsClientListSecretsOptions) (JobsClientListSecretsResponse, error)`
      info	[Changelog] - New function `*JobsClient.BeginStart(context.Context, string, string, JobExecutionTemplate, *JobsClientBeginStartOptions) (*runtime.Poller[JobsClientStartResponse], error)`
      info	[Changelog] - New function `*JobsClient.BeginStopExecution(context.Context, string, string, string, *JobsClientBeginStopExecutionOptions) (*runtime.Poller[JobsClientStopExecutionResponse], error)`
      info	[Changelog] - New function `*JobsClient.BeginStopMultipleExecutions(context.Context, string, string, JobExecutionNamesCollection, *JobsClientBeginStopMultipleExecutionsOptions) (*runtime.Poller[JobsClientStopMultipleExecutionsResponse], error)`
      info	[Changelog] - New function `*JobsClient.BeginUpdate(context.Context, string, string, JobPatchProperties, *JobsClientBeginUpdateOptions) (*runtime.Poller[JobsClientUpdateResponse], error)`
      info	[Changelog] - New function `NewJobsExecutionsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*JobsExecutionsClient, error)`
      info	[Changelog] - New function `*JobsExecutionsClient.NewListPager(string, string, *JobsExecutionsClientListOptions) *runtime.Pager[JobsExecutionsClientListResponse]`
      info	[Changelog] - New function `NewManagedCertificatesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ManagedCertificatesClient, error)`
      info	[Changelog] - New function `*ManagedCertificatesClient.BeginCreateOrUpdate(context.Context, string, string, string, *ManagedCertificatesClientBeginCreateOrUpdateOptions) (*runtime.Poller[ManagedCertificatesClientCreateOrUpdateResponse], error)`
      info	[Changelog] - New function `*ManagedCertificatesClient.Delete(context.Context, string, string, string, *ManagedCertificatesClientDeleteOptions) (ManagedCertificatesClientDeleteResponse, error)`
      info	[Changelog] - New function `*ManagedCertificatesClient.Get(context.Context, string, string, string, *ManagedCertificatesClientGetOptions) (ManagedCertificatesClientGetResponse, error)`
      info	[Changelog] - New function `*ManagedCertificatesClient.NewListPager(string, string, *ManagedCertificatesClientListOptions) *runtime.Pager[ManagedCertificatesClientListResponse]`
      info	[Changelog] - New function `*ManagedCertificatesClient.Update(context.Context, string, string, string, ManagedCertificatePatch, *ManagedCertificatesClientUpdateOptions) (ManagedCertificatesClientUpdateResponse, error)`
      info	[Changelog] - New struct `BuildCollection`
      info	[Changelog] - New struct `BuildConfiguration`
      info	[Changelog] - New struct `BuildProperties`
      info	[Changelog] - New struct `BuildResource`
      info	[Changelog] - New struct `BuilderCollection`
      info	[Changelog] - New struct `BuilderProperties`
      info	[Changelog] - New struct `BuilderResource`
      info	[Changelog] - New struct `BuilderResourceUpdate`
      info	[Changelog] - New struct `BuilderResourceUpdateProperties`
      info	[Changelog] - New struct `ContainerAppJobExecutions`
      info	[Changelog] - New struct `ContainerRegistryWithCustomImage`
      info	[Changelog] - New struct `CorsPolicy`
      info	[Changelog] - New struct `DaprConfiguration`
      info	[Changelog] - New struct `EnvironmentVariable`
      info	[Changelog] - New struct `HTTPGet`
      info	[Changelog] - New struct `IngressStickySessions`
      info	[Changelog] - New struct `Job`
      info	[Changelog] - New struct `JobConfiguration`
      info	[Changelog] - New struct `JobConfigurationManualTriggerConfig`
      info	[Changelog] - New struct `JobConfigurationScheduleTriggerConfig`
      info	[Changelog] - New struct `JobExecution`
      info	[Changelog] - New struct `JobExecutionBase`
      info	[Changelog] - New struct `JobExecutionContainer`
      info	[Changelog] - New struct `JobExecutionNamesCollection`
      info	[Changelog] - New struct `JobExecutionTemplate`
      info	[Changelog] - New struct `JobPatchProperties`
      info	[Changelog] - New struct `JobPatchPropertiesProperties`
      info	[Changelog] - New struct `JobProperties`
      info	[Changelog] - New struct `JobSecretsCollection`
      info	[Changelog] - New struct `JobTemplate`
      info	[Changelog] - New struct `JobsCollection`
      info	[Changelog] - New struct `KedaConfiguration`
      info	[Changelog] - New struct `ManagedCertificate`
      info	[Changelog] - New struct `ManagedCertificateCollection`
      info	[Changelog] - New struct `ManagedCertificatePatch`
      info	[Changelog] - New struct `ManagedCertificateProperties`
      info	[Changelog] - New struct `PreBuildStep`
      info	[Changelog] - New struct `SecretVolumeItem`
      info	[Changelog] - New field `Category` in struct `AvailableWorkloadProfileProperties`
      info	[Changelog] - New field `ManagedBy` in struct `ContainerApp`
      info	[Changelog] - New field `LatestReadyRevisionName`, `WorkloadProfileName` in struct `ContainerAppProperties`
      info	[Changelog] - New field `Identity`, `KeyVaultURL` in struct `ContainerAppSecret`
      info	[Changelog] - New anonymous field `ContainerApp` in struct `ContainerAppsClientUpdateResponse`
      info	[Changelog] - New field `ClientCertificateMode`, `CorsPolicy`, `StickySessions` in struct `Ingress`
      info	[Changelog] - New field `Kind` in struct `ManagedEnvironment`
      info	[Changelog] - New field `DaprConfiguration`, `InfrastructureResourceGroup`, `KedaConfiguration` in struct `ManagedEnvironmentProperties`
      info	[Changelog] - New anonymous field `ManagedEnvironment` in struct `ManagedEnvironmentsClientUpdateResponse`
      info	[Changelog] - New field `RunningState`, `RunningStateDetails` in struct `ReplicaContainer`
      info	[Changelog] - New field `InitContainers`, `RunningState`, `RunningStateDetails` in struct `ReplicaProperties`
      info	[Changelog] - New field `Identity`, `KeyVaultURL` in struct `Secret`
      info	[Changelog] - New field `TerminationGracePeriodSeconds` in struct `Template`
      info	[Changelog] - New field `MountOptions`, `Secrets` in struct `Volume`
      info	[Changelog] - New field `SubPath` in struct `VolumeMount`
      info	[Changelog] - New field `Name` in struct `WorkloadProfile`
      info	[Changelog]
      info	[Changelog] Total 14 breaking change(s), 178 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 5982e482f8edb83a94a2f4239c760240a44abe42. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-appcontainers [View full logs]  [Preview SDK Changes] Breaking Change Detected
      Only show 120 items here, please refer to log for details.
      info	[Changelog]   - Added Type Alias ConnectedEnvironmentsListByResourceGroupResponse
      info	[Changelog]   - Added Type Alias ConnectedEnvironmentsListBySubscriptionNextResponse
      info	[Changelog]   - Added Type Alias ConnectedEnvironmentsListBySubscriptionResponse
      info	[Changelog]   - Added Type Alias ConnectedEnvironmentsStoragesCreateOrUpdateResponse
      info	[Changelog]   - Added Type Alias ConnectedEnvironmentsStoragesGetResponse
      info	[Changelog]   - Added Type Alias ConnectedEnvironmentsStoragesListResponse
      info	[Changelog]   - Added Type Alias ConnectedEnvironmentsUpdateResponse
      info	[Changelog]   - Added Type Alias ContainerAppContainerRunningState
      info	[Changelog]   - Added Type Alias ContainerAppReplicaRunningState
      info	[Changelog]   - Added Type Alias ContainerAppsDiagnosticsGetDetectorResponse
      info	[Changelog]   - Added Type Alias ContainerAppsDiagnosticsGetRevisionResponse
      info	[Changelog]   - Added Type Alias ContainerAppsDiagnosticsGetRootResponse
      info	[Changelog]   - Added Type Alias ContainerAppsDiagnosticsListDetectorsNextResponse
      info	[Changelog]   - Added Type Alias ContainerAppsDiagnosticsListDetectorsResponse
      info	[Changelog]   - Added Type Alias ContainerAppsDiagnosticsListRevisionsNextResponse
      info	[Changelog]   - Added Type Alias ContainerAppsDiagnosticsListRevisionsResponse
      info	[Changelog]   - Added Type Alias ContainerAppsGetAuthTokenResponse
      info	[Changelog]   - Added Type Alias ContainerAppsUpdateResponse
      info	[Changelog]   - Added Type Alias ExtendedLocationTypes
      info	[Changelog]   - Added Type Alias IngressClientCertificateMode
      info	[Changelog]   - Added Type Alias JobExecutionRunningState
      info	[Changelog]   - Added Type Alias JobProvisioningState
      info	[Changelog]   - Added Type Alias JobsCreateOrUpdateResponse
      info	[Changelog]   - Added Type Alias JobsExecutionsListNextResponse
      info	[Changelog]   - Added Type Alias JobsExecutionsListResponse
      info	[Changelog]   - Added Type Alias JobsGetResponse
      info	[Changelog]   - Added Type Alias JobsListByResourceGroupNextResponse
      info	[Changelog]   - Added Type Alias JobsListByResourceGroupResponse
      info	[Changelog]   - Added Type Alias JobsListBySubscriptionNextResponse
      info	[Changelog]   - Added Type Alias JobsListBySubscriptionResponse
      info	[Changelog]   - Added Type Alias JobsListSecretsResponse
      info	[Changelog]   - Added Type Alias JobsStartResponse
      info	[Changelog]   - Added Type Alias JobsStopMultipleExecutionsResponse
      info	[Changelog]   - Added Type Alias JobsUpdateResponse
      info	[Changelog]   - Added Type Alias LogLevel
      info	[Changelog]   - Added Type Alias ManagedCertificateDomainControlValidation
      info	[Changelog]   - Added Type Alias ManagedCertificatesCreateOrUpdateResponse
      info	[Changelog]   - Added Type Alias ManagedCertificatesGetResponse
      info	[Changelog]   - Added Type Alias ManagedCertificatesListNextResponse
      info	[Changelog]   - Added Type Alias ManagedCertificatesListResponse
      info	[Changelog]   - Added Type Alias ManagedCertificatesUpdateResponse
      info	[Changelog]   - Added Type Alias ManagedEnvironmentDiagnosticsGetDetectorResponse
      info	[Changelog]   - Added Type Alias ManagedEnvironmentDiagnosticsListDetectorsResponse
      info	[Changelog]   - Added Type Alias ManagedEnvironmentsDiagnosticsGetRootResponse
      info	[Changelog]   - Added Type Alias ManagedEnvironmentsGetAuthTokenResponse
      info	[Changelog]   - Added Type Alias ManagedEnvironmentsListWorkloadProfileStatesNextResponse
      info	[Changelog]   - Added Type Alias ManagedEnvironmentsListWorkloadProfileStatesResponse
      info	[Changelog]   - Added Type Alias ManagedEnvironmentsUpdateResponse
      info	[Changelog]   - Added Type Alias ProvisioningState
      info	[Changelog]   - Added Type Alias TriggerType
      info	[Changelog]   - Interface CertificateProperties has a new optional parameter subjectAlternativeNames
      info	[Changelog]   - Interface Configuration has a new optional parameter maxInactiveRevisions
      info	[Changelog]   - Interface ContainerApp has a new optional parameter environmentId
      info	[Changelog]   - Interface ContainerApp has a new optional parameter eventStreamEndpoint
      info	[Changelog]   - Interface ContainerApp has a new optional parameter extendedLocation
      info	[Changelog]   - Interface ContainerApp has a new optional parameter latestReadyRevisionName
      info	[Changelog]   - Interface ContainerApp has a new optional parameter managedBy
      info	[Changelog]   - Interface ContainerApp has a new optional parameter workloadProfileName
      info	[Changelog]   - Interface ContainerAppSecret has a new optional parameter identity
      info	[Changelog]   - Interface ContainerAppSecret has a new optional parameter keyVaultUrl
      info	[Changelog]   - Interface CustomHostnameAnalysisResult has a new optional parameter conflictWithEnvironmentCustomDomain
      info	[Changelog]   - Interface Dapr has a new optional parameter enableApiLogging
      info	[Changelog]   - Interface Dapr has a new optional parameter httpMaxRequestSize
      info	[Changelog]   - Interface Dapr has a new optional parameter httpReadBufferSize
      info	[Changelog]   - Interface Dapr has a new optional parameter logLevel
      info	[Changelog]   - Interface DaprComponent has a new optional parameter secretStoreComponent
      info	[Changelog]   - Interface Ingress has a new optional parameter clientCertificateMode
      info	[Changelog]   - Interface Ingress has a new optional parameter corsPolicy
      info	[Changelog]   - Interface Ingress has a new optional parameter exposedPort
      info	[Changelog]   - Interface Ingress has a new optional parameter ipSecurityRestrictions
      info	[Changelog]   - Interface Ingress has a new optional parameter stickySessions
      info	[Changelog]   - Interface ManagedEnvironment has a new optional parameter customDomainConfiguration
      info	[Changelog]   - Interface ManagedEnvironment has a new optional parameter daprConfiguration
      info	[Changelog]   - Interface ManagedEnvironment has a new optional parameter eventStreamEndpoint
      info	[Changelog]   - Interface ManagedEnvironment has a new optional parameter infrastructureResourceGroup
      info	[Changelog]   - Interface ManagedEnvironment has a new optional parameter kedaConfiguration
      info	[Changelog]   - Interface ManagedEnvironment has a new optional parameter kind
      info	[Changelog]   - Interface ManagedEnvironment has a new optional parameter workloadProfiles
      info	[Changelog]   - Interface Replica has a new optional parameter initContainers
      info	[Changelog]   - Interface Replica has a new optional parameter runningState
      info	[Changelog]   - Interface Replica has a new optional parameter runningStateDetails
      info	[Changelog]   - Interface ReplicaContainer has a new optional parameter execEndpoint
      info	[Changelog]   - Interface ReplicaContainer has a new optional parameter logStreamEndpoint
      info	[Changelog]   - Interface ReplicaContainer has a new optional parameter runningState
      info	[Changelog]   - Interface ReplicaContainer has a new optional parameter runningStateDetails
      info	[Changelog]   - Interface Revision has a new optional parameter lastActiveTime
      info	[Changelog]   - Interface ScaleRule has a new optional parameter tcp
      info	[Changelog]   - Interface Secret has a new optional parameter identity
      info	[Changelog]   - Interface Secret has a new optional parameter keyVaultUrl
      info	[Changelog]   - Interface Template has a new optional parameter initContainers
      info	[Changelog]   - Interface Template has a new optional parameter terminationGracePeriodSeconds
      info	[Changelog]   - Interface Volume has a new optional parameter mountOptions
      info	[Changelog]   - Interface Volume has a new optional parameter secrets
      info	[Changelog]   - Interface VolumeMount has a new optional parameter subPath
      info	[Changelog]   - Added Enum KnownAction
      info	[Changelog]   - Added Enum KnownAffinity
      info	[Changelog]   - Added Enum KnownApplicability
      info	[Changelog]   - Added Enum KnownBuildStatus
      info	[Changelog]   - Added Enum KnownConnectedEnvironmentProvisioningState
      info	[Changelog]   - Added Enum KnownContainerAppContainerRunningState
      info	[Changelog]   - Added Enum KnownContainerAppReplicaRunningState
      info	[Changelog]   - Added Enum KnownExtendedLocationTypes
      info	[Changelog]   - Added Enum KnownIngressClientCertificateMode
      info	[Changelog]   - Added Enum KnownJobExecutionRunningState
      info	[Changelog]   - Added Enum KnownJobProvisioningState
      info	[Changelog]   - Added Enum KnownLogLevel
      info	[Changelog]   - Added Enum KnownManagedCertificateDomainControlValidation
      info	[Changelog]   - Added Enum KnownProvisioningState
      info	[Changelog]   - Added Enum KnownTriggerType
      info	[Changelog]   - Enum KnownContainerAppProvisioningState has a new value Deleting
      info	[Changelog]   - Enum KnownIngressTransportMethod has a new value Tcp
      info	[Changelog]   - Enum KnownStorageType has a new value Secret
      info	[Changelog]   - Added function getContinuationToken
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Interface ContainerAppsRevisionsListRevisionsNextOptionalParams no longer has parameter filter
      info	[Changelog]   - Interface VnetConfiguration no longer has parameter runtimeSubnetId
      info	[Changelog]   - Type of parameter customDomainVerificationFailureInfo of interface CustomHostnameAnalysisResult is changed from DefaultErrorResponse to CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo
      info	[Changelog]   - Type of parameter value of interface DaprSecretsCollection is changed from Secret[] to DaprSecret[]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 5982e482f8edb83a94a2f4239c760240a44abe42. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs] Generate from 5982e482f8edb83a94a2f4239c760240a44abe42. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
      SSL error: syscall failure: Broken pipe
      Error: SSL error: syscall failure: Broken pipe
    • ️✔️Az.app.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.app.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Apr 24, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 24, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Swagger Microsoft.App https://apiview.dev/Assemblies/Review/156b61e58e7849f29a90938511bd85a8
    Go sdk/resourcemanager/appcontainers/armappcontainers https://apiview.dev/Assemblies/Review/a9f5ebb926ed41b6ab0f885a682ebbf6
    Java azure-resourcemanager-appcontainers https://apiview.dev/Assemblies/Review/cced109a99524ceb94c1bd6286fd9f4e
    JavaScript @azure/arm-appcontainers Create ApiView failed. Please ask PR assignee for help

    @openapi-workflow-bot
    Copy link

    Hi, @pauld-msft your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    @openapi-workflow-bot
    Copy link

    Hi @pauld-msft, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @openapi-workflow-bot
    Copy link

    Hi @pauld-msft, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 24, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌LintDiff: 5 Errors, 2 Warnings failed [Detail]
    compared tags (via openapi-validator v2.1.1) new version base version
    package-preview-2023-05 package-preview-2023-05(fdc34f4) package-preview-2023-05(release-app-Microsoft.App-2023-05-01-preview)

    [must fix]The following errors/warnings are introduced by current PR:

    Rule Message Related RPC [For API reviewers]
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.App/preview/2023-05-01-preview/Builders.json#L222
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.App/preview/2023-05-01-preview/Builders.json#L290
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.App/preview/2023-05-01-preview/Builders.json#L349
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.App/preview/2023-05-01-preview/Builds.json#L213
    LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
    Location: Microsoft.App/preview/2023-05-01-preview/Builds.json#L285
    ⚠️ ProvisioningStateSpecifiedForLRODelete 200 response schema in long running DELETE operation is missing ProvisioningState property. A LRO DELETE operations 200 response schema must have ProvisioningState specified.
    Location: Microsoft.App/preview/2023-05-01-preview/Builders.json#L332
    ⚠️ ProvisioningStateSpecifiedForLRODelete 200 response schema in long running DELETE operation is missing ProvisioningState property. A LRO DELETE operations 200 response schema must have ProvisioningState specified.
    Location: Microsoft.App/preview/2023-05-01-preview/Builds.json#L268
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand]
    Validation passes for TypeSpec Validation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    },
    "description": "List of custom commands to run."
    },
    "httpGet": {
    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    please confirm this GET isn't made with your first party app's identity. Also, be very careful about following redirects, allowing localhost, and other server-side request forgery type attack vectors.

    Copy link
    Member Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Yes I can confirm that. This GET will be made from within the container app that is identified by the buildComputeId. As this is created through ARM in the customer's subscription, we will not have any sensitive data / 1PA information in it.

    The request will be formatted like curl -o {fileName} -H {header1} -H {header2} {url}

    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Ok. They will likely be able to make requests against the IMDS endpoint that resides inside the container app. Since this is a resource they own that likely isn't a problem but something that needs to be kept in mind. https://learn.microsoft.com/en-us/azure/container-apps/managed-identity?tabs=cli%2Chttp#rest-endpoint-reference

    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    The IMDS endpoint is not available inside a Container App. SSRF is something we need to consider though; @pauld-msft as long as the Build Container App runs in the same end-user context as any other Container App AND we're not sending any sensitive values in the request (secrets, keys, tokens..) then it shouldn't be a problem (it would be no different than a user deploying their own Container App that makes HTTP requests).

    Copy link
    Member Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    @vturecek this is part of the build configuration / pre-build stesps that the user provides. So the user would provide the values that create the http get request. Which means that we wouldn't be sending any sensitive values unless the customer decided to do so

    @pilor pilor added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Apr 25, 2023
    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 25, 2023
    @pauld-msft pauld-msft removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Apr 25, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 25, 2023
    @pilor pilor added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Apr 26, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 26, 2023
    @pauld-msft
    Copy link
    Member Author

    @Wzb123456789 @weidongxu-microsoft would one of you be able to approve this pull request so that it can be merged?

    …example containerApps to jobs to represent latest design
    @pauld-msft
    Copy link
    Member Author

    I've updated this pr based on feedback. Is there anything else that I need to do before this can be approved and merged @Wzb123456789 @weidongxu-microsoft @kazrael2119 ?

    @pauld-msft
    Copy link
    Member Author

    LintDiff failing due to a https://github.com/Azure/azure-openapi-validator/blob/main/docs/lro-error-response.md validation that I assume was introduced in the 0.0.52 version of lintdiff pipeline job, since the 0.0.51 version was able to succeed this past Wednesday.

    We are not using the common error response for these new resources to promote consistency with the rest of the Microsoft.App RP, as it also doesn't use the common-types error.

    @weidongxu-microsoft
    Copy link
    Member

    OK, I've skip that LroErrorContent for now. However I assume yours should be compatible with that in common-types and may consider a swtich.

    @weidongxu-microsoft weidongxu-microsoft merged commit f6c24a1 into release-app-Microsoft.App-2023-05-01-preview May 15, 2023
    @weidongxu-microsoft weidongxu-microsoft deleted the pauld/release-app-Microsoft.App-2023-05-01-preview branch May 15, 2023 01:52
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    8 participants